Skip to content

KDGpu::CommandRecorder

Module: Public API

CommandRecorder.

#include <command_recorder.h>

Public Functions

Name
~CommandRecorder()
CommandRecorder(CommandRecorder && other)
CommandRecorder & operator=(CommandRecorder && other)
CommandRecorder(const CommandRecorder & ) =delete
CommandRecorder & operator=(const CommandRecorder & ) =delete
const Handle< CommandRecorder_t > & handle() const
bool isValid() const
operator Handle< CommandRecorder_t >() const
RenderPassCommandRecorder beginRenderPass(const RenderPassCommandRecorderOptions & options)
RenderPassCommandRecorder beginRenderPass(const RenderPassCommandRecorderWithRenderPassOptions & options)
ComputePassCommandRecorder beginComputePass(const ComputePassCommandRecorderOptions & options ={})
RayTracingPassCommandRecorder beginRayTracingPass(const RayTracingPassCommandRecorderOptions & options ={})
TimestampQueryRecorder beginTimestampRecording(const TimestampQueryRecorderOptions & options ={})
void blitTexture(const TextureBlitOptions & options)
void clearBuffer(const BufferClear & clear)
void clearColorTexture(const ClearColorTexture & clear)
void clearDepthStencilTexture(const ClearDepthStencilTexture & clear)
void copyBuffer(const BufferCopy & copy)
void copyBufferToTexture(const BufferToTextureCopy & copy)
void copyTextureToBuffer(const TextureToBufferCopy & copy)
void copyTextureToTexture(const TextureToTextureCopy & copy)
void updateBuffer(const BufferUpdate & update)
void memoryBarrier(const MemoryBarrierOptions & options)
void bufferMemoryBarrier(const BufferMemoryBarrierOptions & options)
void textureMemoryBarrier(const TextureMemoryBarrierOptions & options)
void executeSecondaryCommandBuffer(const Handle< CommandBuffer_t > & secondaryCommandBuffer)
void resolveTexture(const TextureResolveOptions & options)
void buildAccelerationStructures(const BuildAccelerationStructureOptions & options)
void beginDebugLabel(const DebugLabelOptions & options)
void endDebugLabel()
CommandBuffer finish()

Protected Functions

Name
CommandRecorder(GraphicsApi * api, const Handle< Device_t > & device, const CommandRecorderOptions & options)

Protected Attributes

Name
GraphicsApi * m_api
Handle< Device_t > m_device
Handle< CommandRecorder_t > m_commandRecorder
CommandBufferLevel m_level

Friends

Name
class Device
class Queue

Public Functions Documentation

function ~CommandRecorder

1
~CommandRecorder()

function CommandRecorder

1
2
3
CommandRecorder(
    CommandRecorder && other
)

function operator=

1
2
3
CommandRecorder & operator=(
    CommandRecorder && other
)

function CommandRecorder

1
2
3
CommandRecorder(
    const CommandRecorder & 
) =delete

function operator=

1
2
3
CommandRecorder & operator=(
    const CommandRecorder & 
) =delete

function handle

1
inline const Handle< CommandRecorder_t > & handle() const

function isValid

1
inline bool isValid() const

function operator Handle< CommandRecorder_t >

1
inline operator Handle< CommandRecorder_t >() const

function beginRenderPass

1
2
3
RenderPassCommandRecorder beginRenderPass(
    const RenderPassCommandRecorderOptions & options
)

function beginRenderPass

1
2
3
RenderPassCommandRecorder beginRenderPass(
    const RenderPassCommandRecorderWithRenderPassOptions & options
)

function beginComputePass

1
2
3
ComputePassCommandRecorder beginComputePass(
    const ComputePassCommandRecorderOptions & options ={}
)

function beginRayTracingPass

1
2
3
RayTracingPassCommandRecorder beginRayTracingPass(
    const RayTracingPassCommandRecorderOptions & options ={}
)

function beginTimestampRecording

1
2
3
TimestampQueryRecorder beginTimestampRecording(
    const TimestampQueryRecorderOptions & options ={}
)

function blitTexture

1
2
3
void blitTexture(
    const TextureBlitOptions & options
)

function clearBuffer

1
2
3
void clearBuffer(
    const BufferClear & clear
)

function clearColorTexture

1
2
3
void clearColorTexture(
    const ClearColorTexture & clear
)

function clearDepthStencilTexture

1
2
3
void clearDepthStencilTexture(
    const ClearDepthStencilTexture & clear
)

function copyBuffer

1
2
3
void copyBuffer(
    const BufferCopy & copy
)

function copyBufferToTexture

1
2
3
void copyBufferToTexture(
    const BufferToTextureCopy & copy
)

function copyTextureToBuffer

1
2
3
void copyTextureToBuffer(
    const TextureToBufferCopy & copy
)

function copyTextureToTexture

1
2
3
void copyTextureToTexture(
    const TextureToTextureCopy & copy
)

function updateBuffer

1
2
3
void updateBuffer(
    const BufferUpdate & update
)

function memoryBarrier

1
2
3
void memoryBarrier(
    const MemoryBarrierOptions & options
)

function bufferMemoryBarrier

1
2
3
void bufferMemoryBarrier(
    const BufferMemoryBarrierOptions & options
)

function textureMemoryBarrier

1
2
3
void textureMemoryBarrier(
    const TextureMemoryBarrierOptions & options
)

function executeSecondaryCommandBuffer

1
2
3
void executeSecondaryCommandBuffer(
    const Handle< CommandBuffer_t > & secondaryCommandBuffer
)

function resolveTexture

1
2
3
void resolveTexture(
    const TextureResolveOptions & options
)

function buildAccelerationStructures

1
2
3
void buildAccelerationStructures(
    const BuildAccelerationStructureOptions & options
)

function beginDebugLabel

1
2
3
void beginDebugLabel(
    const DebugLabelOptions & options
)

function endDebugLabel

1
void endDebugLabel()

function finish

1
CommandBuffer finish()

Protected Functions Documentation

function CommandRecorder

1
2
3
4
5
explicit CommandRecorder(
    GraphicsApi * api,
    const Handle< Device_t > & device,
    const CommandRecorderOptions & options
)

Protected Attributes Documentation

variable m_api

1
GraphicsApi * m_api { nullptr };

variable m_device

1
Handle< Device_t > m_device;

variable m_commandRecorder

1
Handle< CommandRecorder_t > m_commandRecorder;

variable m_level

1
CommandBufferLevel m_level;

Friends

friend Device

1
2
3
friend class Device(
    Device 
);

friend Queue

1
2
3
friend class Queue(
    Queue 
);

Updated on 2025-11-02 at 00:01:42 +0000