FidelityFX Brixelizer

Navigation: SDK → Effect Components

FidelityFX Brixelizer

FidelityFX Brixelizer runtime library.

Defines

FFX_BRIXELIZER_CONTEXT_SIZE

#define FFX_BRIXELIZER_CONTEXT_SIZE (5938838)

The size of the context specified in 32bit values.

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 30, column 9)

FFX_BRIXELIZER_UPDATE_DESCRIPTION_SIZE

#define FFX_BRIXELIZER_UPDATE_DESCRIPTION_SIZE 2099376

The size of the update description specified in 32bit values.

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 35, column 9)

FFX_BRIXELIZER_VERSION_MAJOR

#define FFX_BRIXELIZER_VERSION_MAJOR (1)

FidelityFX Brixelizer major version.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 38, column 9)

FFX_BRIXELIZER_VERSION_MINOR

#define FFX_BRIXELIZER_VERSION_MINOR (0)

FidelityFX Brixelizer minor version.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 43, column 9)

FFX_BRIXELIZER_VERSION_PATCH

#define FFX_BRIXELIZER_VERSION_PATCH (0)

FidelityFX Brixelizer patch version.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 48, column 9)

FFX_BRIXELIZER_CONTEXT_COUNT

#define FFX_BRIXELIZER_CONTEXT_COUNT 1

FidelityFX Brixelizer context count.

Defines the number of internal effect contexts required by Brixelizer

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 55, column 9)

FFX_BRIXELIZER_RAW_CONTEXT_SIZE

#define FFX_BRIXELIZER_RAW_CONTEXT_SIZE (2924058)

The size of the raw context specified in 32bit values.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 60, column 9)

Functions

ffxBrixelizerGetContextSize

inline size_t ffxBrixelizerGetContextSize()

Get the size in bytes needed for an FfxBrixelizerContext struct. Note that this function is provided for consistency, and the size of the FfxBrixelizerContext is a known compile time value which can be obtained using sizeof(FfxBrixelizerContext).

Returns: The size in bytes of an FfxBrixelizerContext struct.

Returns: size_t

Attributes: inline

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 199, column 15)

ffxBrixelizerContextCreate

FFX_API FfxErrorCode ffxBrixelizerContextCreate(const FfxBrixelizerContextDescription *desc, FfxBrixelizerContext *outContext)

Create a FidelityFX Brixelizer context from the parameters specified to the FfxBrixelizerContextDesc struct.

The context structure is the main object used to interact with the Brixelizer API, and is responsible for the management of the internal resources used by the Brixelizer algorithm. When this API is called, multiple calls will be made via the pointers contained in the backendInterface structure. This backend will attempt to retrieve the device capabilities, and create the internal resources, and pipelines required by Brixelizer.

Depending on the parameters passed in via the contextDescription a different set of resources and pipelines may be requested by the callback functions.

The FfxBrixelizerContext should be destroyed when use of it is completed. To destroy the context you should call ffxBrixelizerContextDestroy.

desc

An FfxBrixelizerContextDescription structure with the parameters for context creation.

outContext

An FfxBrixelizerContext structure for receiving the initialized Brixelizer context.

FFX_OK

The operation completed successfully.

Parameters:

• desc (const FfxBrixelizerContextDescription *) – [in] An FfxBrixelizerContextDescription structure with the parameters for context creation.
• outContext (FfxBrixelizerContext *) – [out] An FfxBrixelizerContext structure for receiving the initialized Brixelizer context.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 227, column 22)

ffxBrixelizerContextDestroy

FFX_API FfxErrorCode ffxBrixelizerContextDestroy(FfxBrixelizerContext *context)

Delete the Brixelizer context associated with the FfxBrixelizerContext struct.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 237, column 22)

ffxBrixelizerGetContextInfo

FFX_API FfxErrorCode ffxBrixelizerGetContextInfo(FfxBrixelizerContext *context, FfxBrixelizerContextInfo *contextInfo)

Fill in an FfxBrixelizerContextInfo struct for necessary for updating a constant buffer for use by Brixelizer when ray marching.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• contextInfo (FfxBrixelizerContextInfo *) – [out] An FfxBrixelizerContextInfo struct to be filled.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 249, column 22)

ffxBrixelizerBakeUpdate

FFX_API FfxErrorCode ffxBrixelizerBakeUpdate(FfxBrixelizerContext *context, const FfxBrixelizerUpdateDescription *desc, FfxBrixelizerBakedUpdateDescription *outDesc)

Build an FfxBrixelizerBakedUpdateDescription struct from an FfxBrixelizerUpdateDescription struct for use in doing a Brixelizer update.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• desc (const FfxBrixelizerUpdateDescription *) – [in] An FfxBrixelizerUpdateDescription struct containing the parameters for the update.
• outDesc (FfxBrixelizerBakedUpdateDescription *) – [out] An FfxBrixelizerBakedUpdateDescription struct to be filled in.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 262, column 22)

ffxBrixelizerUpdate

FFX_API FfxErrorCode ffxBrixelizerUpdate(FfxBrixelizerContext *context, FfxBrixelizerBakedUpdateDescription *desc, FfxResource scratchBuffer, FfxCommandList commandList)

Perform an update of Brixelizer, recording GPU commands to a command list.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• desc (FfxBrixelizerBakedUpdateDescription *) – [in] An FfxBrixelizerBakedUpdateDescription describing the update to compute.
• scratchBuffer (FfxResource) – [out] An FfxResource to be used as scratch space by the update.
• commandList (FfxCommandList) – [out] An FfxCommandList to write GPU commands to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 275, column 22)

ffxBrixelizerRegisterBuffers

FFX_API FfxErrorCode ffxBrixelizerRegisterBuffers(FfxBrixelizerContext *context, const FfxBrixelizerBufferDescription *bufferDescs, uint32_t numBufferDescs)

Register a vertex or index buffer to use with Brixelizer.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• bufferDescs (const FfxBrixelizerBufferDescription *)
• numBufferDescs (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 287, column 22)

ffxBrixelizerUnregisterBuffers

FFX_API FfxErrorCode ffxBrixelizerUnregisterBuffers(FfxBrixelizerContext *context, const uint32_t *indices, uint32_t numIndices)

Unregister a previously registered vertex or index buffer.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• indices (const uint32_t *)
• numIndices (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 298, column 22)

ffxBrixelizerCreateInstances

FFX_API FfxErrorCode ffxBrixelizerCreateInstances(FfxBrixelizerContext *context, const FfxBrixelizerInstanceDescription *descs, uint32_t numDescs)

Create a static instance for a Brixelizer context.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• descs (const FfxBrixelizerInstanceDescription *) – [in] An array of FfxBrixelizerInstanceDescription structs with the parameters for instance creation.
• numDescs (uint32_t) – [in] The number of entries in the array passed in by descs.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 310, column 22)

ffxBrixelizerDeleteInstances

FFX_API FfxErrorCode ffxBrixelizerDeleteInstances(FfxBrixelizerContext *context, const FfxBrixelizerInstanceID *instanceIDs, uint32_t numInstanceIDs)

Delete a static instance from a Brixelizer context.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• instanceIDs (const FfxBrixelizerInstanceID *) – [in] An array of FfxBrixelizerInstanceIDs corresponding to instances to be destroyed.
• numInstanceIDs (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 322, column 22)

ffxBrixelizerGetRawContext

FFX_API FfxErrorCode ffxBrixelizerGetRawContext(FfxBrixelizerContext *context, FfxBrixelizerRawContext **outContext)

Get a pointer to the underlying Brixelizer raw context from a Brixelizer context.

Returns: FFX_ERROR_INVALID_POINTER The pointer given was invalid.

Returns: FFX_OK The operation completed successfully.

Parameters:

• context (FfxBrixelizerContext *) – [inout] An FfxBrixelizerContext containing the Brixelizer context.
• outContext (FfxBrixelizerRawContext **) – [out] A FfxBrixelizerRawContext representing the underlying Brixelizer raw context.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 335, column 22)

ffxBrixelizerRawGetContextSize

inline size_t ffxBrixelizerRawGetContextSize()

Get the size in bytes needed for an FfxBrixelizerRawContext struct. Note that this function is provided for consistency, and the size of the FfxBrixelizerRawContext is a known compile time value which can be obtained using sizeof(FfxBrixelizerRawContext).

Returns: The size in bytes of an FfxBrixelizerRawContext struct.

Returns: size_t

Attributes: inline

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 306, column 15)

ffxBrixelizerRawContextCreate

FFX_API FfxErrorCode ffxBrixelizerRawContextCreate(FfxBrixelizerRawContext *context, const FfxBrixelizerRawContextDescription *contextDescription)

Create a FidelityFX Brixelizer context from the parameters specified to the FfxBrixelizerRawContextDescription struct.

The context structure is the main object used to interact with the Brixelizer API, and is responsible for the management of the internal resources used by the Brixelizer algorithm. When this API is called, multiple calls will be made via the pointers contained in the backendInterface structure. This backend will attempt to retrieve the device capabilities, and create the internal resources, and pipelines required by Brixelizer.

Depending on the parameters passed in via the contextDescription a different set of resources and pipelines may be requested by the callback functions.

The FfxBrixelizerRawContext should be destroyed when use of it is completed. To destroy the context you should call ffxBrixelizerContextDestroy.

context

A pointer to a FfxBrixelizerRawContext to populate.

contextDescription

A pointer to a FfxBrixelizerRawContextDescription specifying the parameters for context creation.

FFX_OK

The operation completed successfully.

FFX_ERROR_INVALID_POINTER

The operation failed because either context or contextDescription was NULL.

FFX_ERROR_INCOMPLETE_INTERFACE

The operation failed because contextDescription->backendInterface was not fully specified.

FFX_ERROR_BACKEND_API_ERROR

The operation failed because of an error from the backend.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] A pointer to a FfxBrixelizerRawContext to populate.
• contextDescription (const FfxBrixelizerRawContextDescription *) – [in] A pointer to a FfxBrixelizerRawContextDescription specifying the parameters for context creation.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 340, column 22)

ffxBrixelizerRawContextDestroy

FFX_API FfxErrorCode ffxBrixelizerRawContextDestroy(FfxBrixelizerRawContext *context)

Destroy the FidelityFX Brixelizer context.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] A pointer to a FfxBrixelizerRawContext structure to destroy.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 352, column 22)

ffxBrixelizerRawContextGetInfo

FFX_API FfxErrorCode ffxBrixelizerRawContextGetInfo(FfxBrixelizerRawContext *context, FfxBrixelizerContextInfo *contextInfo)

Get an FfxBrixelizerContextInfo structure with the details for context. This call is intended to be used to fill in a constant buffer necessary for making ray queries.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to receive the FfxBrixelizerContextInfo of.
• contextInfo (FfxBrixelizerContextInfo *) – [out] A FfxBrixelizerContextInfo struct to be filled in.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 367, column 22)

ffxBrixelizerRawContextCreateCascade

FFX_API FfxErrorCode ffxBrixelizerRawContextCreateCascade(FfxBrixelizerRawContext *context, const FfxBrixelizerRawCascadeDescription *cascadeDescription)

Create a cascade for use with Brixelizer.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to create a cascade for.
• cascadeDescription (const FfxBrixelizerRawCascadeDescription *) – [in] A FfxBrixelizerRawCascadeDescription struct specifying the parameters for cascade creation.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 382, column 22)

ffxBrixelizerRawContextDestroyCascade

FFX_API FfxErrorCode ffxBrixelizerRawContextDestroyCascade(FfxBrixelizerRawContext *context, uint32_t cascadeIndex)

Destroy a cascade previously created with ffxBrixelizerContextCreateCascade.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to delete a cascade for.
• cascadeIndex (uint32_t) – [in] The index of the cascade to delete.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 395, column 22)

ffxBrixelizerRawContextResetCascade

FFX_API FfxErrorCode ffxBrixelizerRawContextResetCascade(FfxBrixelizerRawContext *context, uint32_t cascadeIndex)

Reset a cascade previously created with ffxBrixelizerContextCreateCascade.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to reset a cascade for.
• cascadeIndex (uint32_t) – [in] The index of the cascade to reset.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 410, column 22)

ffxBrixelizerRawContextBegin

FFX_API FfxErrorCode ffxBrixelizerRawContextBegin(FfxBrixelizerRawContext *context, FfxBrixelizerResources resources)

Begin constructing GPU commands for updating SDF acceleration structures with Brixelizer. Must be called between calls to ffxBrixelizerContextBegin and ffxBrixelizerContextEnd.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to begin a frame for.
• resources (FfxBrixelizerResources)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 425, column 22)

ffxBrixelizerRawContextEnd

FFX_API FfxErrorCode ffxBrixelizerRawContextEnd(FfxBrixelizerRawContext *context)

End construcring GPU commands for updating the SDF acceleration structures with Brixelizer.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to end a frame for.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 439, column 22)

ffxBrixelizerRawContextSubmit

FFX_API FfxErrorCode ffxBrixelizerRawContextSubmit(FfxBrixelizerRawContext *context, FfxCommandList cmdList)

Record GPU commands to a FfxCommandList for updating acceleration structures with Brixelizer.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to record GPU commands from.
• cmdList (FfxCommandList) – [out] The FfxCommandList to record commands to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 454, column 22)

ffxBrixelizerRawContextGetScratchMemorySize

FFX_API FfxErrorCode ffxBrixelizerRawContextGetScratchMemorySize(FfxBrixelizerRawContext *context, const FfxBrixelizerRawCascadeUpdateDescription *cascadeUpdateDescription, size_t *size)

Get the size in bytes needed from a FfxResource to be used as a scratch buffer in a cascade update.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to calculate the required scratch buffer size for.
• cascadeUpdateDescription (const FfxBrixelizerRawCascadeUpdateDescription *) – [in] A FfxBrixelizerRawCascadeUpdateDescription struct with the parameters for the cascade update.
• size (size_t *) – [out] A size_t to store the required scratch buffer size to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 470, column 22)

ffxBrixelizerRawContextUpdateCascade

FFX_API FfxErrorCode ffxBrixelizerRawContextUpdateCascade(FfxBrixelizerRawContext *context, const FfxBrixelizerRawCascadeUpdateDescription *cascadeUpdateDescription)

Update a cascade in a Brixelizer context.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to perform the cascade update on.
• cascadeUpdateDescription (const FfxBrixelizerRawCascadeUpdateDescription *) – [in] A FfxBrixelizerRawCascadeUpdateDescription struct with the parameters for the cascade update.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 485, column 22)

ffxBrixelizerRawContextMergeCascades

FFX_API FfxErrorCode ffxBrixelizerRawContextMergeCascades(FfxBrixelizerRawContext *context, uint32_t src_cascade_A_idx, uint32_t src_cascade_B_idx, uint32_t dst_cascade_idx)

Merge two cascades in a Brixelizer context. Must be called between calls to ffxBrixelizerRawContextBegin and ffxBrixelizerRawContextEnd.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to merge cascades for.
• src_cascade_A_idx (uint32_t)
• src_cascade_B_idx (uint32_t)
• dst_cascade_idx (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 503, column 22)

ffxBrixelizerRawContextBuildAABBTree

FFX_API FfxErrorCode ffxBrixelizerRawContextBuildAABBTree(FfxBrixelizerRawContext *context, uint32_t cascadeIndex)

Build an AABB tree for a cascade in a Brixelizer context. Must be called between calls to ffxBrixelizerRawContextBegin and ffxBrixelizerRawContextEnd.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to build an AABB tree for.
• cascadeIndex (uint32_t) – [in] The index of the cascade to build the AABB tree of.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 519, column 22)

ffxBrixelizerRawContextDebugVisualization

FFX_API FfxErrorCode ffxBrixelizerRawContextDebugVisualization(FfxBrixelizerRawContext *context, const FfxBrixelizerDebugVisualizationDescription *debugVisualizationDescription)

Create a debug visualization output of a Brixelizer context. Must be called between calls to ffxBrixelizerRawContextBegin and ffxBrixelizerRawContextEnd.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to create a debug visualization for.
• debugVisualizationDescription (const FfxBrixelizerDebugVisualizationDescription *) – [in] A FfxBrixelizerDebugVisualizationDescription providing the parameters for the debug visualization.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 535, column 22)

ffxBrixelizerRawContextGetDebugCounters

FFX_API FfxErrorCode ffxBrixelizerRawContextGetDebugCounters(FfxBrixelizerRawContext *context, FfxBrixelizerDebugCounters *debugCounters)

Get the debug counters from a Brixelizer context. Note to use this function the flag FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CONTEXT_READBACK_BUFFERS must be passed at context creation.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to read the debug counters of.
• debugCounters (FfxBrixelizerDebugCounters *) – [out] A FfxBrixelizerDebugCounters struct to read the debug counters to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 550, column 22)

ffxBrixelizerRawContextGetCascadeCounters

FFX_API FfxErrorCode ffxBrixelizerRawContextGetCascadeCounters(FfxBrixelizerRawContext *context, uint32_t cascadeIndex, FfxBrixelizerScratchCounters *counters)

Get the cascade counters from a Brixelizer context. Note to use this function the flag FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CASCADE_READBACK_BUFFERS must be passed at context creation.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to read the cascade counters of.
• cascadeIndex (uint32_t) – [in] The index of the cascade to read the cascade counters of.
• counters (FfxBrixelizerScratchCounters *) – [out] A FfxBrixelizerScratchCounters struct to read the cascade counters to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 566, column 22)

ffxBrixelizerRawContextCreateInstances

FFX_API FfxErrorCode ffxBrixelizerRawContextCreateInstances(FfxBrixelizerRawContext *context, const FfxBrixelizerRawInstanceDescription *instanceDescriptions, uint32_t numInstanceDescriptions)

Create an instance in a Brixelizer context.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to create an instance for.
• instanceDescriptions (const FfxBrixelizerRawInstanceDescription *)
• numInstanceDescriptions (uint32_t) – [out] A FfxBrixelizerInstanceID to read the instance ID to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 580, column 22)

ffxBrixelizerRawContextDestroyInstances

FFX_API FfxErrorCode ffxBrixelizerRawContextDestroyInstances(FfxBrixelizerRawContext *context, const FfxBrixelizerInstanceID *instanceIDs, uint32_t numInstanceIDs)

Destroy an instance in a Brixelizer context.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to delete an instance for.
• instanceIDs (const FfxBrixelizerInstanceID *)
• numInstanceIDs (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 593, column 22)

ffxBrixelizerRawContextFlushInstances

FFX_API FfxErrorCode ffxBrixelizerRawContextFlushInstances(FfxBrixelizerRawContext *context, FfxCommandList cmdList)

Flush all instances added to the Brixelizer context with ffxBrixelizerRawContextCreateInstance to the GPU.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to flush the instances for.
• cmdList (FfxCommandList) – [in] An FfxCommandList to record GPU commands to.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 606, column 22)

ffxBrixelizerRawContextRegisterBuffers

FFX_API FfxErrorCode ffxBrixelizerRawContextRegisterBuffers(FfxBrixelizerRawContext *context, const FfxBrixelizerBufferDescription *bufferDescs, uint32_t numBufferDescs)

Register a vertex or index buffer for use with Brixelizer.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to register a buffer for.
• bufferDescs (const FfxBrixelizerBufferDescription *)
• numBufferDescs (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 620, column 22)

ffxBrixelizerRawContextUnregisterBuffers

FFX_API FfxErrorCode ffxBrixelizerRawContextUnregisterBuffers(FfxBrixelizerRawContext *context, const uint32_t *indices, uint32_t numIndices)

Unregister a previously registered vertex or index buffer.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to unregister the buffer from
• indices (const uint32_t *)
• numIndices (uint32_t)

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 633, column 22)

ffxBrixelizerRawContextRegisterScratchBuffer

FFX_API FfxErrorCode ffxBrixelizerRawContextRegisterScratchBuffer(FfxBrixelizerRawContext *context, FfxResource scratchBuffer)

Get the index of the recommended cascade to update given the total number of cascades and current frame. Follows the pattern 0 1 0 2 0 1 0 3 0 etc. If 0 is the most detailed cascade and maxCascades - 1 is the least detailed cascade this ordering updates more detailed cascades more often.

Parameters:

• context (FfxBrixelizerRawContext *) – [out] The FfxBrixelizerRawContext to set a buffer for.
• scratchBuffer (FfxResource) – [in] A FfxResource for use as a scratch buffer.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 648, column 22)

ffxBrixelizerRawGetCascadeToUpdate

FFX_API uint32_t ffxBrixelizerRawGetCascadeToUpdate(uint32_t frameIndex, uint32_t maxCascades)

Get the index of the recommended cascade to update given the total number of cascades and current frame. Follows the pattern 0 1 0 2 0 1 0 3 0 etc. If 0 is the most detailed cascade and maxCascades - 1 is the least detailed cascade this ordering updates more detailed cascades more often.

Parameters:

• frameIndex (uint32_t) – [in] The current frame index.
• maxCascades (uint32_t) – [in] The total number of cascades.

Returns: FFX_API uint32_t

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 660, column 22)

ffxBrixelizerRawResourceIsNull

FFX_API bool ffxBrixelizerRawResourceIsNull(FfxResource resource)

Check whether an FfxResource is NULL.

Parameters:

• resource (FfxResource) – [in] An FfxResource to check for nullness.

Returns: FFX_API bool

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 669, column 22)

ffxBrixelizerGetEffectVersion

FFX_API FfxVersionNumber ffxBrixelizerGetEffectVersion()

Queries the effect version number.

Returns: The SDK version the effect was built with.

Returns: FFX_API FfxVersionNumber

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 677, column 26)

Typedefs

FfxBrixelizerInstanceID

typedef uint32_t FfxBrixelizerInstanceID

An ID value for an instance created with Brixelizer.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 117, column 18)

Enumerations

FfxBrixelizerCascadeFlag

enum FfxBrixelizerCascadeFlag

Flags used for cascade creation. A cascade may be specified as having static geometry, dynamic geometry, or both by combining these flags.

Values:

FFX_BRIXELIZER_CASCADE_STATIC

FFX_BRIXELIZER_CASCADE_STATIC = (1 <<0)

FFX_BRIXELIZER_CASCADE_DYNAMIC

FFX_BRIXELIZER_CASCADE_DYNAMIC = (1 <<1)

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 69, column 1)

FfxBrixelizerPopulateDebugAABBsFlags

enum FfxBrixelizerPopulateDebugAABBsFlags

Flags used for setting which AABBs to draw in a debug visualization of Brixelizer.

Values:

FFX_BRIXELIZER_POPULATE_AABBS_NONE

FFX_BRIXELIZER_POPULATE_AABBS_NONE = 0

Draw no AABBs.

FFX_BRIXELIZER_POPULATE_AABBS_STATIC_INSTANCES

FFX_BRIXELIZER_POPULATE_AABBS_STATIC_INSTANCES = 1 <<0

Draw AABBs for all static instances.

FFX_BRIXELIZER_POPULATE_AABBS_DYNAMIC_INSTANCES

FFX_BRIXELIZER_POPULATE_AABBS_DYNAMIC_INSTANCES = 1 <<1

Draw AABBs for all dynamic instances.

FFX_BRIXELIZER_POPULATE_AABBS_INSTANCES

FFX_BRIXELIZER_POPULATE_AABBS_INSTANCES = FFX_BRIXELIZER_POPULATE_AABBS_STATIC_INSTANCES | FFX_BRIXELIZER_POPULATE_AABBS_DYNAMIC_INSTANCES

Draw AABBs for all instances.

FFX_BRIXELIZER_POPULATE_AABBS_CASCADE_AABBS

FFX_BRIXELIZER_POPULATE_AABBS_CASCADE_AABBS = 1 <<2

Draw AABBs for all cascades.

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 96, column 1)

FfxBrixelizerInstanceFlags

enum FfxBrixelizerInstanceFlags

Flags used for specifying instance properties.

Values:

FFX_BRIXELIZER_INSTANCE_FLAG_NONE

FFX_BRIXELIZER_INSTANCE_FLAG_NONE = 0

No instance flags set.

FFX_BRIXELIZER_INSTANCE_FLAG_DYNAMIC

FFX_BRIXELIZER_INSTANCE_FLAG_DYNAMIC = 1 <<0

This flag is set for any instance which should be added to the dynamic cascade. Indicates that this instance will be resubmitted every frame.

Source: sdk/include/FidelityFX/host/ffx_brixelizer.h (line 162, column 1)

FfxBrixelizerPass

enum FfxBrixelizerPass

An enumeration of all the passes which constitute the Brixelizer algorithm.

Brixelizer is implemented as a composite of several compute passes each computing a key part of the final result. Each call to the FfxBrixelizerScheduleGpuJobFunc callback function will correspond to a single pass included in FfxBrixelizerPass. For a more comprehensive description of each pass, please refer to the Brixelizer reference documentation.

Values:

FFX_BRIXELIZER_PASS_CONTEXT_CLEAR_COUNTERS

FFX_BRIXELIZER_PASS_CONTEXT_COLLECT_CLEAR_BRICKS

FFX_BRIXELIZER_PASS_CONTEXT_PREPARE_CLEAR_BRICKS

FFX_BRIXELIZER_PASS_CONTEXT_CLEAR_BRICK

FFX_BRIXELIZER_PASS_CONTEXT_COLLECT_DIRTY_BRICKS

FFX_BRIXELIZER_PASS_CONTEXT_PREPARE_EIKONAL_ARGS

FFX_BRIXELIZER_PASS_CONTEXT_EIKONAL

FFX_BRIXELIZER_PASS_CONTEXT_MERGE_CASCADES

FFX_BRIXELIZER_PASS_CONTEXT_PREPARE_MERGE_BRICKS_ARGS

FFX_BRIXELIZER_PASS_CONTEXT_MERGE_BRICKS

FFX_BRIXELIZER_PASS_CASCADE_CLEAR_BUILD_COUNTERS

FFX_BRIXELIZER_PASS_CASCADE_RESET_CASCADE

FFX_BRIXELIZER_PASS_CASCADE_SCROLL_CASCADE

FFX_BRIXELIZER_PASS_CASCADE_CLEAR_REF_COUNTERS

FFX_BRIXELIZER_PASS_CASCADE_CLEAR_JOB_COUNTER

FFX_BRIXELIZER_PASS_CASCADE_INVALIDATE_JOB_AREAS

FFX_BRIXELIZER_PASS_CASCADE_COARSE_CULLING

FFX_BRIXELIZER_PASS_CASCADE_SCAN_JOBS

FFX_BRIXELIZER_PASS_CASCADE_VOXELIZE

FFX_BRIXELIZER_PASS_CASCADE_SCAN_REFERENCES

FFX_BRIXELIZER_PASS_CASCADE_COMPACT_REFERENCES

FFX_BRIXELIZER_PASS_CASCADE_CLEAR_BRICK_STORAGE

FFX_BRIXELIZER_PASS_CASCADE_EMIT_SDF

FFX_BRIXELIZER_PASS_CASCADE_COMPRESS_BRICK

FFX_BRIXELIZER_PASS_CASCADE_INITIALIZE_CASCADE

FFX_BRIXELIZER_PASS_CASCADE_MARK_UNINITIALIZED

FFX_BRIXELIZER_PASS_CASCADE_BUILD_TREE_AABB

FFX_BRIXELIZER_PASS_CASCADE_FREE_CASCADE

FFX_BRIXELIZER_PASS_DEBUG_VISUALIZATION

FFX_BRIXELIZER_PASS_DEBUG_INSTANCE_AABBS

FFX_BRIXELIZER_PASS_DEBUG_AABB_TREE

FFX_BRIXELIZER_PASS_COUNT

The number of passes performed by Brixelizer.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 76, column 1)

FfxBrixelizerCascadeDebugAABB

enum FfxBrixelizerCascadeDebugAABB

Flags used for specifying debug drawing of AABBs.

Values:

FFX_BRIXELIZER_CASCADE_DEBUG_AABB_NONE

FFX_BRIXELIZER_CASCADE_DEBUG_AABB_BOUNDING_BOX

FFX_BRIXELIZER_CASCADE_DEBUG_AABB_AABB_TREE

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 150, column 1)

FfxBrixelizerContextFlags

enum FfxBrixelizerContextFlags

Flags for options for Brixelizer context creation.

Values:

FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CONTEXT_READBACK_BUFFERS

FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CONTEXT_READBACK_BUFFERS = (1 <<0)

Create a context with context readback buffers enabled. Needed to use ffxBrixelizerContextGetDebugCounters.

FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CASCADE_READBACK_BUFFERS

FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CASCADE_READBACK_BUFFERS = (1 <<1)

Create a context with cascade readback buffers enabled. Needed to use ffxBrixelizerContextGetCascadeCounters.

FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_AABBS

FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_AABBS = (1 <<2)

Create a context with debug AABBs enabled.

FFX_BRIXELIZER_CONTEXT_FLAG_ALL_DEBUG

FFX_BRIXELIZER_CONTEXT_FLAG_ALL_DEBUG = FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CONTEXT_READBACK_BUFFERS | FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CASCADE_READBACK_BUFFERS | FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_AABBS

Create a context with all debugging features enabled.

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 182, column 1)

FfxBrixelizerRawJobFlags

enum FfxBrixelizerRawJobFlags

Flags used for creating Brixelizer jobs. Determines whether a job is a submission of geometry or invalidating an area described by an AABB.

Values:

FFX_BRIXELIZER_RAW_JOB_FLAG_NONE

FFX_BRIXELIZER_RAW_JOB_FLAG_NONE = 0u

FFX_BRIXELIZER_RAW_JOB_FLAG_INVALIDATE

FFX_BRIXELIZER_RAW_JOB_FLAG_INVALIDATE = 1u <<2u

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 194, column 1)

FfxBrixelizerRawInstanceFlags

enum FfxBrixelizerRawInstanceFlags

Flags used for creating Brixelizer instances.

Values:

FFX_BRIXELIZER_RAW_INSTANCE_FLAG_NONE

FFX_BRIXELIZER_RAW_INSTANCE_FLAG_NONE = 0u

FFX_BRIXELIZER_RAW_INSTANCE_FLAG_USE_INDEXLESS_QUAD_LIST

FFX_BRIXELIZER_RAW_INSTANCE_FLAG_USE_INDEXLESS_QUAD_LIST = 1u <<1u

Source: sdk/include/FidelityFX/host/ffx_brixelizer_raw.h (line 202, column 1)

Dependencies

This module depends on:

• FfxBrixelizerBakedUpdateDescription
• FfxBrixelizerBufferDescription
• FfxBrixelizerContext
• FfxBrixelizerContextDescription
• FfxBrixelizerContextInfo
• FfxBrixelizerDebugCounters
• FfxBrixelizerDebugVisualizationDescription
• FfxBrixelizerInstanceDescription
• FfxBrixelizerRawCascadeDescription
• FfxBrixelizerRawCascadeUpdateDescription
• FfxBrixelizerRawContext
• FfxBrixelizerRawContextDescription
• FfxBrixelizerRawInstanceDescription
• FfxBrixelizerResources
• FfxBrixelizerScratchCounters
• FfxBrixelizerUpdateDescription
• FfxResource