LiteFX::Rendering::Backends::DirectX12FrameBuffer::descriptorHandle¶
descriptorHandle overloads
Synopses¶
Declared in <litefx/backends/dx12.hpp>
Returns the descriptor handle for an image with the specified name.
[[dllimport, dllexport]] D3D12_CPU_DESCRIPTOR_HANDLE descriptorHandle(StringView imageName) const;
Returns the descriptor handle for an image at the specified index.
[[dllimport, dllexport]] D3D12_CPU_DESCRIPTOR_HANDLE descriptorHandle(UInt32 imageIndex) const;
Returns the descriptor handle for an image mapped to the specified render target.
[[dllimport, dllexport]] D3D12_CPU_DESCRIPTOR_HANDLE descriptorHandle(RenderTarget const& renderTarget) const;
Exceptions¶
| Name | Thrown on |
|---|---|
InvalidArgumentException | Thrown, if the provided image name does refer to an image within the frame buffer. |
ArgumentOutOfRangeException | Thrown, if the provided image index does not address an image within the frame buffer. |
Return Value¶
The descriptor handle for the image.
Parameters¶
| Name | Description |
|---|---|
| imageName | The name of the image for which the descriptor handle should be returned. |
| imageIndex | The index of the image for which the descriptor handle should be returned. |
| renderTarget | The render target for which to return the image descriptor handle. |