FfxPipelineDescription
A structure containing the description used to create a FfxPipeline structure.
File location: sdk/include/FidelityFX/host/ffx_types.h
Detailed description
A structure containing the description used to create a FfxPipeline structure.
A pipeline is the name given to a shader and the collection of state that is required to dispatch it. In the context of the FidelityFX SDK and its architecture this means that a FfxPipelineDescription will map to either a monolithic object in an explicit API (such as a PipelineStateObject in DirectX 12). Or a shader and some ancillary API objects (in something like DirectX 11).
The contextFlags field contains a copy of the flags passed to ffxContextCreate via the flags field of the Ffx<Effect>InitializationParams structure. These flags are used to determine which permutation of a pipeline for a specific Ffx<Effect>Pass should be used to implement the features required by each application, as well as to achieve the best performance on specific target hardware configurations.
When using one of the provided backends for FidelityFX SDK (such as DirectX 12 or Vulkan) the data required to create a pipeline is compiled off line and included into the backend library that you are using. For cases where the backend interface is overridden by providing custom callback function implementations care should be taken to respect the contents of the contextFlags field in order to correctly support the options provided by the FidelityFX SDK, and achieve best performance. ///
Data fields
|
Type |
Description |
|---|---|
|
uint32_t |
contextFlags
A collection of “FfxInitializationFlagBits“ which were passed to the context.
|
|
const FfxSamplerDescription * |
samplers
A collection of samplers to use when building the root signature for the pipeline.
|
|
size_t |
samplerCount
Number of samplers to create for the pipeline.
|
|
const FfxRootConstantDescription * |
rootConstants
A collection of root constant descriptions to use when building the root signature for the pipeline.
|
|
uint32_t |
rootConstantBufferCount
Number of root constant buffers to create for the pipeline.
|
|
wchar_t |
name
Pipeline name with which to name the pipeline object.
|
|
FfxBindStage |
stage
The stage(s) for which this pipeline is being built.
|
|
uint32_t |
indirectWorkload
Whether this pipeline has an indirect workload.
|
|
FfxSurfaceFormat |
backbufferFormat
For raster pipelines this contains the backbuffer format.
|
