Structs
@brief Resource access attribute.
@brief Requirements for a single memory allocation.
@brief Memory allocator interface.
@brief Buffer resource view.
@brief Parameters for clearing a depth stencil resource.
@brief Parameters for clearing a resource.
@brief Command callback with usage parameters.
@brief Parameters of a command callback context.
@brief Diagnostic information for a command of the render graph command stream.
@brief Parameters for explicitly beginning a render pass from a command callback.
@brief Output resources for writing results of a graphics node.
@brief Screen regions to render to.
@brief Parameters of a batch of commands to be recorded by the graphics API in use.
@brief Creation parameters for an RpsDevice .
@brief Required parameters for a GPU memory allocation.
@brief Diagnostic information for a heap.
@brief Parameters of a resource placement inside a heap.
@brief Image resource view.
@brief Parameters of a memory type.
@brief Parameters for describing a render graph node.
@brief Parameters for creating a dummy runtime device.
@brief Function parameter attribute.
@brief Parameters for describing a node call parameter.
@brief Printer interface.
Parameters for creating an RPS program.
@brief Random number generator interface.
Rectangular geometrical figure.
@brief Parameters of the command batch layout of a render graph.
@brief Parameters for creating a render graph.
@brief Diagnostic information for parts of a render graph.
@brief Parameters for executing a render graph.
@brief Parameters of a render graph processing phase.
@brief Parameters for recording commands using a processed render graph.
@brief Parameters for describing a render graph signature.
@brief Parameters for updating a render graph.
@brief Parameters for accessing a resource.
@brief Parameters for a resource description.
@brief Diagnostic information for a resource.
@brief General resource view.
@brief Callback functions of a runtime.
@brief Parameters for creating a runtime device.
@brief Parameters for creating a custom GPU memory heap.
@brief Parameters for creating the used defined resources associated with a node.
@brief Parameters for creating a runtime resource.
@brief Parameters for destroying an array of runtime GPU memory heaps.
@brief Parameters for destroying an array of runtime resources.
@brief Parameters for recording a debug marker command.
@brief Parameters for setting a resource debug name.
@brief Parameters of a runtime resource.
@brief Graph entry and node parameter semantic attribute.
@brief Parameters of a source code location.
@brief Subsection of a resource from the graphics API perspective.
@brief Parameters of a type used in the RPS library.
Screen region to render to.
Constants
Final state when exiting the node. This allows a view to have a different state at entering and exiting,
in case the node implementation needs to perform a transition but does not want to transition it back to the
original state. Not implemented yet.
Bitwise OR of all GPU / CPU access, excluding decorator flags such as RPS_ACCESS_RELAXED_ORDER_BIT and RPS_ACCESS_NO_VIEW_BIT.
Bitwise OR of all possible CPU access flags.
Bitwise OR of all possible GPU access flags.
Bitwise OR of all possible GPU readonly access flags.
Bitwise OR of all possible GPU writeable access flags.
Initial state when entering the node. This allows a view to have a different state at entering and exiting,
in case the node implementation needs to perform a transition but does not want to transition it back to the
original state. Not implemented yet.
View is cleared before the current access. Usually used together with other basic access flags.
< Accessible as a constant buffer.
< Accessible as a copy target.
< Accessible as a copy source.
< Accessible for reads by the CPU.
< Accessible for writes by the CPU.
Depth read write access.
< Accessible as a readonly depth view.
Depth / Stencil read write access.
Depth / Stencil read access.
Depth / Stencil write access.
< Accessible as a writable depth view.
Access does not read existing data so it can be discarded.
< Accessible as an index buffer.
< Accessible as an indirect argument buffer.
Access does not need a resource view to be created, (e.g. via
ID3D12GraphicsCommandList::CopyResource).
Accessible as a predication buffer.
< Accessible as a present source.
< Accessible for write (build) as a raytracing acceleration
< Accessible for read as a raytracing acceleration structure.
Access does not care about the ordering with regard to other accesses which also have the
RPS_ACCESS_RELAXED_ORDER_BIT flag.
Access can be used by a render pass attachment (as render target or depth stencil). Used to distinguish clear-only
accesses (which may use special clear commands) and render target / depth stencil view accesses.
< Accessible as a render target view.
< Accessible as a resolve target.
< Accessible as a resolve source.
< Accessible as a shader resource (readonly) view.
< Accessible as a shading rate image in a Variable Rate Shading
Stencil read write access.
< Accessible as a readonly stencil view.
< Accessible as a writable stencil view.
< Accessible for write as a stream out buffer.
< Unknown access.
< Accessible as a unordered access (shader readwrite) view.
< Accessible as a vertex buffer.
< 32-bit boolean type.
< 32-bit floating point type.
< 64-bit floating point type.
< 8-bit signed integer type.
< 16-bit signed integer type.
< 32-bit signed integer type.
< 64-bit signed integer type.
< Number of built-in types.
< 8-bit unsigned integer type.
< 16-bit unsigned integer type.
< 32-bit unsigned integer type.
< 64-bit unsigned integer type.
< General type with specified size.
< Starting value of the type id range reserved for runtime defined types.
< Starting value of the type id range reserved for user defined types.
< Clears the color aspect of a render target view.
< Clears the depth aspect of a depth stencil view.
< No clear flags are specified. (Not a valid use case).
< Clears the stencil aspect of a depth stencil view.
< Clears the UAV with floating point data.
< Clears the UAV with integer data.
Skips default render target / depth stencil buffer setup, even if any were specified in the node parameter
semantics.
Skips render state & resource binding setup other than render targets (including depth stencil buffer) and
viewport (including scissor rects).
Skips viewport and scissor rect setup during command node setup. Used when the command callback will do the
setup instead.
No callback properties.
The command callback will record command buffer in a multi-threaded way. This may change the render pass setup
behavior as required by some graphics APIs.
< Enable all flags.
< Dumps the directed acyclic graph of nodes defined
< Dumps the commands of the render graph after
< Dumps the resources and commands of a render graph
< Sets resource names as debug names in the graphics
< Inserts source code location debug data for
< No diagnostic mode enabled.
< Video resource format with opaque layout.
< RGB video resource format with 8-bit palletization.
< Single channel A format with the channel being a normalized, 8-bit unsigned integer.
< 4-bit palletized video resource format.
< 4-channel video resource format with each channel being a 8-bit value.
< 4-channels BGRA format with each channel being a normalized 4-bit unsigned integer.
4-channel BGRA format with the first three channels being a normalized, 5-bit unsigned integer and the last one
a normalized, 1-bit unsigned integer.
3-channel BGR format with the first channel being a normalized, 5-bit unsigned integer, the second one a
normalized, 6-bit unsigned integer and the third one a normalized, 5-bit unsigned integer.
< 4-channel BGRA format with each channel being a typeless 8-bit value.
4-channel BGRA format with each channel being a normalized, 8-bit unsigned integer.
< 4-channel BGRA format with each channel being a normalized, 8-bit unsigned
< 3-channel BGR format with each channel being a typeless 8-bit value and 8
3-channel BGR format with each channel being a normalized, 8-bit unsigned integer value and 8 unused bits at the
end.
< 3-channel BGR format with each channel being a normalized, 8-bit unsigned
4-channel block compressed format with the first channel being a typeless 5-bit value, the second one a
typeless, 6-bit value, the third one a typeless, 5-bit value and the last one a typeless, 0-bit or 1-bit value.
4-channel block compressed format with the first channel being a normalized, 5-bit unsigned integer, the second
one a normalized, 6-bit unsigned integer, the third one a normalized, 5-bit unsigned integer and the last one a
normalized, 0-bit or 1-bit unsigned integer.
4-channel block compressed format with the first channel being a normalized, 5-bit unsigned integer SRGB value,
the second one a normalized, 6-bit unsigned integer SRGB value, the third one a normalized, 5-bit unsigned
integer SRGB valu eand the last one a normalized, 0-bit or 1-bit unsigned integer SRGB value.
4-channel block compressed format with the first channel being a typeless 5-bit value, the second one a
typeless, 6-bit value, the third one a typeless, 5-bit value and the last one a typeless, 4-bit value.
4-channel block compressed format with the first channel being a normalized, 5-bit unsigned integer, the second
one a normalized, 6-bit unsigned integer, the third one a normalized, 5-bit unsigned integer and the last one a
normalized, 4-bit unsigned integer.
4-channel block compressed format with the first channel being a normalized, 5-bit unsigned integer SRGB value,
the second one a normalized, 6-bit unsigned integer SRGB value, the third one a normalized, 5-bit unsigned
integer SRGB value and the last one a normalized, 4-bit unsigned integer SRGB value.
4-channel block compressed format with the first channel being a typeless 5-bit value, the second one a
typeless, 6-bit value, the third one a typeless, 5-bit value and the last one a typeless, 8-bit value.
4-channel block compressed format with the first channel being a normalized, 5-bit unsigned integer, the second
one a normalized, 6-bit unsigned integer, the third one a normalized, 5-bit unsigned integer and the last one a
normalized, 8-bit unsigned integer.
4-channel block compressed format with the first channel being a normalized, 5-bit unsigned integer SRGB value,
the second one a normalized, 6-bit unsigned integer SRGB value, the third one a normalized, 5-bit unsigned
integer SRGB value and the last one a normalized, 0-bit or 1-bit unsigned integer SRGB value.
Single channel block compressed format with the channel being a normalized, 8-bit signed integer value.
Single channel block compressed format with the channel being a typeless 8-bit value.
Single channel block compressed format with the channel being a normalized, 8-bit signed integer value.
2-channel block compressed format with each channel being a normalized, 8-bit signed integer value.
2-channel block compressed format with each channel being a typeless 8-bit value.
2-channel block compressed format with each channel being a normalized, 8-bit unsigned integer value.
3-channel block compressed HDR format with each channel being a 16-bit signed “half” floating point value.
3-channel block compressed HDR format with each channel being a typeless 16-bit value.
3-channel block compressed HDR format with each channel being a 16-bit unsigned “half” floating point value.
3-channel or 4-channel block compressed format with the first three channels being a typeless, 4-7-bit value and
the last one an optional, typeless 0-8-bit value.
3-channel or 4-channel block compressed format with the first three channels being an normalized, 4-7-bit
unsigned integer and the last one an optional, normalized, 0-8-bit unsigned integer.
3-channel or 4-channel block compressed format with the first three channels being an normalized, 4-7-bit
unsigned integer and the last one an optional, normalized, 0-8-bit unsigned integer .
< Number of formats available in RpsFormat .
< Single channel R format with the channel being a 16-bit IEEE 754 floating point
2-channel RG format with the first channel being a normalized, 24-bit unsigned integer depth value and the
second one an 8-bit unsigned integer stencil value.
< Single channel R format with the channel being a 32-bit IEEE 754 floating point depth
2-channel RG format with the first channel being a 32-bit depth value, the second one a 8-bit unsigned integer
value and 24 unused bits at the end.
4-channel RGB format with each channel being a normalized, 8-bit unsigned integer. Each block of 32 bits
describes the RGB values for a pair of pixels that always share one R and B value but have separate G values.
< 4-bit palletized video resource format.
< 2-channel video resource format with each channel being a 8-bit value.
< 2-channel video resource format with each channel being a 8-bit value.
< RGB video resource format with 8-bit palletization.
< 2-channel video resource format with each channel being a 16-bit value.
< 2-channel video resource format with each channel being a 8-bit value.
< Single channel R format with the channel being a 1-bit unsigned integer.
< 4-channel RGBA format with all channels being 8-bit signed integers.
< 4-channel RGBA format with all channels being normalized, 8-bit signed
< 4-channel RGBA format with all channels being typeless 8-bit values.
< 4-channel RGBA format with all channels being 8-bit unsigned integers.
< 4-channel RGBA format with all channels being normalized 8-bit unsigned
< 4-channel RGBA format with all channels being normalized 8-bit unsigned integer
4-channel RGB format with each channel being a normalized, 8-bit unsigned integer. Each block of 32 bits
describes the RGB values for a pair of pixels that always share one R and B value but have separate G values.
< 2-channel RG format with each channel being a 8-bit signed integer.
< 2-channel RG format with each channel being a normalized, 8-bit signed integer.
< 2-channel RG format with each channel being a typeless 8-bit value.
< 2-channel RG format with each channel being a 8-bit unsigned integer.
< 2-channel RG format with each channel being a normalized, 8-bit unsigned integer.
< Single channel R format with the channel being a 8-bit signed integer.
< Single channel R format with the channel being a normalized, 8-bit signed integer.
< Single channel R format with the channel being a typeless 8-bit value.
< Single channel R format with the channel being a 8-bit signed integer.
< Single channel R format with the channel being a normalized, 8-bit unsigned integer.
4-channel RGB format with the first three channels being a 9-bit mantissa. Together with the 5-bit exponent that
is shared for all three channels they form three 9-bit mantissa + 5-bit exponent floating point value.
4-channel RGBA format with the RGB channels being typeless 10-bit values and the A channel being a typeless
2-bit value.
4-channel RGBA format with the RGB channels being 10-bit unsigned integer values and the A channel being a 2-bit
unsigned integer value.
4-channel RGBA format with the RGB channels being 10-bit normalized, unsigned integer values and the A channel
being a 2-bit normalized, unsigned integer value.
4-channel RGB 2.8-biased fixed-point format with the first three channels being a normalized, 10-bit
unsigned integer and the last one a normalized 2-bit unsigned integer.
3-channel RGB format with the RG channels being 11-bit floating point values and the B channel being a 10-bit
floating point value.
< 4-channel RGBA format with each channel being a 16-bit floating point
4-channel RGBA format with each channel being a 16-bit signed integer.
< 4-channel RGBA format with each channel being a normalized, 16-bit signed
< 4-channel RGBA format with each channel being a typeless 16-bit value.
< 4-channel RGBA format with each channel being a 16-bit unsigned integer.
< 4-channel RGBA format with each channel being a normalized, 16-bit unsigned
< 2-channel RG format with each channel being a 16-bit IEEE 754 floating point value.
< 2-channel RG format with each channel being a 16-bit signed integer.
< 2-channel RG format with each channel being a normalized, 16-bit signed integer
< 2-channel RG format with each channel being a typeless 16-bit value.
< 2-channel RG format with each channel being a 16-bit unsigned integer.
< 2-channel RG format with each channel being a normalized, 16-bit unsigned integer.
< Single channel R format with the channel being a 16-bit IEEE 754 floating point
< Single channel R format with the channel being a 16-bit signed integer.
< Single channel R format with the channel being a normalized, 16-bit signed integer.
< Single channel R format with the channel being a typeless 16-bit value.
< Single channel R format with the channel being a 16-bit signed integer.
< Single channel R format with the channel being a 16-bit unsigned integer.
2-channel RG format with the first channel being a typeless 24-bit value and the second one a typeless 8-bit
value.
2-channel RG format with the first channel being a normalized, 24-bit unsigned integer value and the second one
a typeless 8-bit value.
2-channel RG format with the first channel being a typeless 32-bit value, the second channel a typeless 8-bit
value and 24 unused bits at the end.
< 4-channel RGBA format with each channel being a 32-bit IEEE 754 floating
< 4-channel RGBA format with each channel being a 32-bit signed integer.
< 4-channel RGBA format with each channel being a typeless 32-bit value.
< 4-channel RGBA format with each channel being a 32-bit unsigned integer.
< 3-channel RGB format with each channel being a 32-bit IEEE 754 floating
< 3-channel RGB format with each channel being a 32-bit signed integer.
< 3-channel RGB format with each channel being a typeless 32-bit value.
< 3-channel RGB format with each channel being a 32-bit unsigned integer.
2-channel RG format with each channel being a 32-bit IEEE 754 floating point value.
2-channel RG format with each channel being a 32-bit signed integer.
2-channel RG format with each channel being a typeless 32-bit value.
2-channel RG format with each channel being a 32-bit unsigned integer.
< Single channel R format with the channel being a 32-bit IEEE 754 floating point
Single channel R format with the channel being a typeless 32-bit IEEE 754 floating point value and additional
sets of 8 and 24 unused bits afterwards.
< Single channel R format with the channel being a 32-bit signed integer.
< Single channel R format with the channel being a typeless 32-bit value.
< Single channel R format with the channel being a 32-bit unsigned integer.
< Unknown format.
Single channel R format with 24 unused bits with the channel being an 8-bit unsigned integer.
Single channel R format with 32 unused bits, the channel being an 8-bit unsigned integer value and 24 unused
bits at the end.
< 4-channel video resource format with each channel being a 16-bit value.
< 4-channel video resource format with each channel being a 16-bit value.
< 4-channel video resource format with each of the first three channels being a
< 4-channel video resource format with each channel being a 16-bit value.
< 4-channel video resource format with each channel being a 8-bit value.
Image aspect usage is unknown.
The metadata aspect is used.
The color aspect is used.
The stencil aspect is used.
The depth aspect is used.
< Node requires a queue with compute capabilities.
< Node requires a queue with copy capabilities.
< No node declaration properties.
< Node requires a queue with graphics capabilites.
< Node prefers to be executed asynchronously.
< Node prefers to be executed as a render pass if the API backend
< No node instance properties.
< Node prefers to be executed asynchronously.
< No bit flags.
< Node parameter is optional.
< Node parameter is an output parameter.
< Node parameter is an RPS resource.
< Forces the enumeration to be int32 type. Do not use!!!
< Line list topology.
< Line list with adjacency topology.
< Line strip topology.
< Line strip with adjacency topology.
< Patch list. The number of control points in the patch list
< Point list topology.
< Triangle list topology.
< Triangle list with adjacency topology.
< Triangle strip topology.
< Triangle strip with adjacency topology.
< Undefined topology.
< Compute capabilities.
< Copy capabilities.
< Graphics capabilities.
< No capabilities.
< Enables per-command debug markers during
< No recording options.
< Diagnostic info is taken from the latest frame.
< The previously cached diagnostic info is returned
< if not called for the first time.
< Disallows unbound nodes if no default callback is set.
< No special properties.
< Disables GPU memory aliasing.
< Resolve operation outputs the average value of all MSAA samples.
< Decoding sampler feedback map (DX12 only).
< Encoding sampler feedback map (DX12 only).
< Resolve operation outputs the maximum value of all MSAA samples.
< Resolve operation outputs the minimum value of all MSAA samples.
< Supports cubemap views.
< No special properties.
< Resource data is persistent from frame to
< Preferred to be in dedicated allocation or as
< Preferred to be in GPU-local CPU-visible heap
< Uses rowmajor image layout.
< A buffer resource type.
< Count of defined resource type values.
< A 1D image resource type.
< A 2D image resource type.
< A 3D image resource type.
< Resource type is unknown / invalid.
Specifies the default component mapping (where R, G, B, A components map to R, G, B, A without swizzling).
Note this is using 1 byte each channel, different from DX12 default.
< Green component.
< Constant value of 1.
< Constant value of 0.
< Resource view is used as a cubemap.
< No special resource view flags.
Failure due to a command being already finalized.
Failure due to not being able to find the specified file.
Failure due to an index being out of its valid bounds.
Failure due to an integer overflow.
Failure due to an RPS library internal error.
Failure due to a data layout mismatch between runtime and shader.
Failure due to invalid arguments.
Failure due to invalid data.
Failure due to an invalid file format.
Failure due to an invalid operation.
Failure due to a compiled RPSL shader program being ill formed. Normally indicates a compiler error.
Failure due to a key value being duplicated where it is required to be unique.
Failure due to a key not being found.
Failure due to a feature not being implemented yet.
Failure due to a feature not being supported.
Failure due to running out of memory.
Failure due to exclusive ranges overlapping.
Failure due to failed a runtime API without direct mapping of the API error code.
Failure due to a failed type safety check.
Failure due to an unknown node.
Failure due to an unrecognized command.
Failure due to an unspecified error.
Failure due to an RPSL module being incompatible with the current runtime.
Failure due to the file format version being too new.
Failure due to the file format version being too old.
Failure due to rpsRenderPipelineValidate finding an invalid pipeline configuration. More details are provided
via output of the device print function.
Successful completion.
Number of unique RPS result codes.
< Type ID of RpsBufferView.
< Type ID of RpsImageView.
< Beginning of a marker region.
< End of a marker region.
< Standalone label.
< Render pass executes secondary command
< No special behavior.
< Resuming render pass in D3D12.
< Current render pass is on a secondary
< Suspending render pass in D3D12.
Reserved for future use. Allows work to overlap between multiple frames.
Includes split barriers where appropriate.
Reserved for future use. Avoids rescheduling if possible and uses the existing schedule instead.
Uses default options. This is identical to RPS_SCHEDULE_UNSPECIFIED in most cases, except when used as
RpsRenderGraphUpdateInfo::scheduleFlags, instead using the default options regardless of
RpsRenderGraphCreateInfo::scheduleInfo::scheduleFlags. This default behavior is a baseline set of criteria used
for scheduling to which these flags can add additional ones.
Prioritizes a lower memory footprint over performance.
Pioritizes application performance over a lower memory footprint.
Disables dead code elimination optimization. By default, RPS removes nodes that have no visible effect (Not
contributing to modification of external, temporal, persistent or CPU resources). This flag disables this
optimization.
Reserved for future use. Uses standalone transition nodes instead of render pass transitions.
Command nodes are kept in the program order.
Avoids alternating between graphics and compute work on the same queue. This can help for some architectures
where switching between graphics and compute produces extra overhead.
Schedules in favor of reducing total GPU memory usage. Possible strategies include minimizing transient resource
lifetimes and agressive aliasing. This may increase the number of barriers generated.
Reserved for future use. Tries to use render pass transitions instead of standalone transition nodes when
possible. If RPS_SCHEDULE_DISABLE_RENDERPASS_TRANSITIONS_BIT is set, this flag will have no effect.
Schedules commands randomly (without changing program logic). Mostly useful for testing purposes. Applications
should normally avoid using this flag for end-user scenarios. If RPS_SCHEDULE_KEEP_PROGRAM_ORDER_BIT is set,
this flag will have no effect.
No schedule flag bits are specified. Default options are used. When used as
RpsRenderGraphUpdateInfo::scheduleFlags, the RpsRenderGraphCreateInfo::scheduleInfo::scheduleFlags specified
at render graph creation time are used instead.
Performs aggressive work pipelining based on the workload type. If
RPS_SCHEDULE_WORKLOAD_TYPE_PIPELINING_DISABLE_BIT is set, this flag will have not effect.
Disables work pipelining based on the workload type.
< Reserved for future use.
Reserved for future use.
< Reserved for future use.
Usage as a color clear value. The data type must be float[4].
< Reserved for future use.
< Number of defined semantics.
Reserved for future use.
Usage as a depth clear value. The data type must be float.
< Reserved for future use.
Bound as a depth stencil view.
< Reserved for future use.
< Start of the dynamic state semantic enumeration values.
< Reserved for future use.
< Reserved for future use.
Bound as an index buffer.
Bound as an indirect argument buffer.
Bound for write as a stream out buffer. The semantic index indicates the stream out buffer binding slot.
< Reserved for future use.
Reserved for future use.
< Reserved for future use.
Reserved for future use.
Usage as primitive topology. The data must be one of the values specified by RpsPrimitiveTopology .
< Reserved for future use.
< Reserved for future use.
Bound as a render target view. The semantic index indicates the render target slot.
< Reserved for future use.
Bound as a resolve target. The semantic index indicates the render
target slot of the resolve source.
Start of the resource binding enumeration values.
Reserved for future use.
Usage as a scissor rectangle. The data type must be RpsRect .
Reserved for future use.
Bound as a shading rate image in a Variable Rate Shading (VRS) pass.
Usage as a stencil clear value. The data type must be uint32_t, only the lower 8 bit will be used.
Reserved for future use.
Bound as an indirect count buffer.
< Reserved for future use.
< Reserved for future use.
< No semantics.
User defined resource view binding. This is intended for shader resource views and unordered access views where
resources are bound to programmable shaders instead of fixed function binding points.
Bound as a vertex buffer. The semantic index indicates the vertex buffer binding slot.
< Reserved for future use.
< Reserved for future use.
Usage as a viewport. The data type must be RpsViewport .
< All shader stages.
< Amplification shader stage.
< Compute shader stage.
< Domain shader stage.
< Geometry shader stage.
< Hull shader stage.
< Mesh shader stage.
< No shader stages.
< Pixel shader stage.
< Raytracing shader stage.
< Vertex shader stage.
< The subgraph is atomic, so external nodes may not be reorderd
< No subgraph properties.
< The subgraph is sequential, the relative order of its nodes should be
Functions
@brief Begins a rasterization rendering pass.
@brief Reports an error from a command callback context.
@brief Clones a command callback context to create a secondary context and assigns it a new command buffer.
@brief Ends a rasterization rendering pass.
@brief Gets the resource access info from a resource node argument.
@brief Gets an array of resource access infos from a resource node argument.
@brief Gets the resource description from a node argument.
@brief Gets an array of resource descriptions of a resource node argument.
@brief Gets the runtime resource from a resource node argument.
@brief Gets an array of runtime resources from a resource node argument.
@brief Gets the description of the current cmd node.
@brief Gets the description of a node argument.
@brief Gets the render targets parameters from the current recording context.
@brief Gets the viewport info from the current recording context.
@brief Sets a new command buffer to be used for command recording.
@brief Creates a device object.
@brief Destroys an RPS device object.
@brief Accesses user data of an RPS device.
@brief Gets the name string of a format.
@brief Returns whether a format has a depth component.
@brief Returns whether a format has a depth or a stencil component.
@brief Returns whether a format has a stencil component.
@brief Returns whether a format is block compressed.
@brief Returns whether a format has only a depth component and no stencil component.
@brief Returns the single element byte size for a format.
@brief Gets the global debug printer.
@brief Generates an RPSL entry name.
@brief Creates a dummy runtime.
@brief Binds a command node callback to a node declaration specified by name.
@brief Binds a subprogram to a node declaration specified by name.
@brief Creates a subprogram.
@brief Destroys a subprogram instance.
@brief Adds a render graph node to a render graph.
@brief Allocates memory from a render graph builder.
@brief Allocates memory from a render graph builder with alignment requirements.
@brief Creates a render graph.
@brief Declare an on-demand node type during the render graph construction.
@brief Declare a render graph managed resource.
@brief Destroys a render graph.
@brief Executes a render graph.
@brief Gets the command batch layout of a render graph.
@brief Gets diagnostic information from a render graph.
@brief Gets the main entry of a render graph.
@brief Gets the runtime resource info of an output parameter.
@brief Gets the resource ID of a resource parameter by the parameter ID.
@brief Gets a variable from the render graph builder by its ID.
@brief Gets the runtime resource info from a resource ID.
@brief Records graphics API commands from a processed render graph.
@brief Updates a render graph.
@brief Gets the name string of a result code.
@brief Initializes an RPSL DLL module.
@brief Gets the signature description of an RPSL entry point.
@brief Sets the global debug printer which is used for diagnostic purposes when no device context is available.
Type Definitions
@brief Signature of functions for acquiring command buffers in a simplified execution mode.
@brief Signature of functions for allocating memory.
@brief Signature of render graph node callbacks.
@brief Signature of functions for destroying device objects.
@brief Signature of functions for freeing allocated memory.
@brief Signature of functions for printing with variadic arguments.
@brief Signature of functions for generating random integers uniformly distributed on the closed interval
[minValue, maxValue].
@brief Signature of functions for reallocating memory.
@brief Signature of functions for render graph building.
@brief Signature of functions for destroying a render graph phase object.
@brief Signature of functions for executing a render graph phase.
@brief Signature of functions for creating a runtime heap.
@brief Signature of functions for creating a runtime resource.
@brief Signature of functions for destroying runtime heaps.
@brief Signature of functions for destroying runtime resources.
@brief Signature of functions for defining an array of render graph phases.
@brief Signature of functions for destroying a runtime device.
@brief Creates the user defined resources associated with a node.
@brief Destroys the user defined resources associated with a node.
@brief Signature of functions for recording runtime debug markers.
@brief Signature of functions for setting runtime debug names.
@brief Signature of functions for submitting command buffers in a simplified execution mode.
@brief Signature of functions for printing with a variable argument list.
@brief Signature of functions for initializing RPSL processes from a DLL.
@brief Bitflags for resource (view) access attributes.
@brief Bitmask type for RpsAccessFlagBits .
@brief Boolean value type.
@brief Integer type ids for all built-in types, e.g. integers and floating point types.
@brief Bitflags for the way a resource should be cleared.
@brief Bitflags for command callback properties.
@brief Bitmask type for RpsCmdCallbackFlagBits .
@brief Transparent handle type for a general, immutable render graph variable.
@brief Bitflags for enabling diagnostic systems.
@brief Bitmask type for RpsDiagnosticFlagBits .
@brief Type for holding up to 16 bitflags.
@brief Type for holding up to 32 bitflags.
@brief Type for holding up to 64 bitflags.
@brief Supported RPS formats.
@brief Type for heap identifiers.
@brief Bitflags for used aspects of an image resource.
@brief Bitmask type for RpsImageAspectUsageFlagBits .
@brief Type for general 32-bit index values.
@brief Bitflags for properties of a render graph node declaration.
@brief Bitmask type for RpsNodeDeclFlagBits .
@brief Type for render graph node declaration identifiers.
@brief Bitflags for node instance properties.
@brief Bitmask type for RpsNodeFlagBits of properties for a render graph node instance.
@brief Type for render graph node identifiers.
@brief Type for function parameter identifiers.
@brief Bitflags for decorating node parameters.
@brief Bitmask type for RpsParameterFlagBits .
@brief Primitive topology types.
@brief Bitflags for queue capabilities.
@brief Bitmask type for RpsQueueFlagBits .
@brief Bitflags for recording commands.
@brief Bitmask type for RpsRecordCommandFlagBits .
@brief Bitflags for diagnostic info modes.
@brief Bitmask type for RpsRenderGraphDiagnosticInfoFlagBits .
@brief Bitflags for special render graph properties.
@brief Bitmask type for RpsRenderGraphFlagBits .
@brief Resolve mode types for built-in resolve node.
@brief Bitflags for special properties of a resource.
@brief Bitmask type for RpsResourceFlagBits .
@brief Type for resource identifiers.
@brief Resource types used by RPS resources.
@brief Resource components or value to map to for component mapping.
@brief Bitflags for resource view properties.
@brief Bitmask for RpsResourceViewFlagBits .
@brief Result and error codes used by operations of the RPS library.
@brief Type for RPSL entry point declarations.
@brief Enumeration of runtime defined built-in type IDs.
@brief Debug marker modes.
@brief Bitflags for render pass behavior.
@brief Bitmask type for RpsRuntimeRenderPassFlagBits .
@brief Bitflags for scheduling behavior.
@brief Bitmask type for RpsScheduleFlagBits .
@brief Graphics resource and argument data usage semantics.
@brief Bitflags for shader stages.
@brief Bitmask type for RpsShaderStageBits .
@brief Type for files represented by an RPSL internal integer identifier.
@brief Bitflags for subgraph properties.
@brief Bitmask type for RpsSubgraphFlagBits .
@brief Integer type ids for any kind of type.
@brief Transparent handle type for a general render graph variable.
Bitmask type for an internal entry flags type.
Unions
@brief RGBA color value to use for clearing a resource.
@brief General value a resource can be cleared to.