SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SDL::GPUComputePass Class Reference

An opaque handle representing a compute pass. More...

Public Member Functions

constexpr GPUComputePass (GPUComputePassRaw gPUComputePass={})
 Wraps GPUComputePass. More...
 
constexpr bool operator== (const GPUComputePass &other) const =default
 Default comparison operator.
 
constexpr bool operator== (GPUComputePassRaw gPUComputePass) const
 Compares with the underlying type.
 
constexpr operator GPUComputePassRaw () const
 Unwraps to the underlying GPUComputePass. More...
 
void BindPipeline (GPUComputePipeline compute_pipeline)
 Binds a compute pipeline on a command buffer for use in compute dispatch. More...
 
void BindSamplers (Uint32 first_slot, std::span< const GPUTextureSamplerBinding > texture_sampler_bindings)
 Binds texture-sampler pairs for use on the compute shader. More...
 
void BindStorageTextures (Uint32 first_slot, SpanRef< const GPUTextureRaw > storage_textures)
 Binds storage textures as readonly for use on the compute pipeline. More...
 
void BindStorageBuffers (Uint32 first_slot, SpanRef< const GPUBufferRaw > storage_buffers)
 Binds storage buffers as readonly for use on the compute pipeline. More...
 
void Dispatch (Uint32 groupcount_x, Uint32 groupcount_y, Uint32 groupcount_z)
 Dispatches compute work. More...
 
void DispatchIndirect (GPUBuffer buffer, Uint32 offset)
 Dispatches compute work with parameters set from a buffer. More...
 
void End ()
 Ends the current compute pass. More...
 

Detailed Description

This handle is transient and should not be held or referenced after GPUComputePass.End is called.

Since
This struct is available since SDL 3.2.0.
See also
GPUCommandBuffer.BeginComputePass
GPUComputePass.End

Constructor & Destructor Documentation

◆ GPUComputePass()

constexpr SDL::GPUComputePass::GPUComputePass ( GPUComputePassRaw  gPUComputePass = {})
inlineconstexpr
Parameters
gPUComputePassthe value to be wrapped

Member Function Documentation

◆ operator GPUComputePassRaw()

constexpr SDL::GPUComputePass::operator GPUComputePassRaw ( ) const
inlineconstexpr
Returns
the underlying GPUComputePassRaw.

The documentation for this class was generated from the following file: