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

An opaque handle representing a graphics pipeline. More...

Public Member Functions

constexpr GPUGraphicsPipeline (GPUGraphicsPipelineRaw gPUGraphicsPipeline={})
 Wraps GPUGraphicsPipeline. More...
 
 GPUGraphicsPipeline (GPUDeviceParam device, const GPUGraphicsPipelineCreateInfo &createinfo)
 Creates a pipeline object to be used in a graphics workflow. More...
 
constexpr bool operator== (const GPUGraphicsPipeline &other) const =default
 Default comparison operator.
 
constexpr bool operator== (GPUGraphicsPipelineRaw gPUGraphicsPipeline) const
 Compares with the underlying type.
 
constexpr operator GPUGraphicsPipelineRaw () const
 Unwraps to the underlying GPUGraphicsPipeline. More...
 

Detailed Description

Used during render passes.

Since
This struct is available since SDL 3.2.0.
See also
GPUGraphicsPipeline.GPUGraphicsPipeline
GPURenderPass.BindPipeline
GPUDevice.ReleaseGraphicsPipeline

Constructor & Destructor Documentation

◆ GPUGraphicsPipeline() [1/2]

constexpr SDL::GPUGraphicsPipeline::GPUGraphicsPipeline ( GPUGraphicsPipelineRaw  gPUGraphicsPipeline = {})
inlineconstexpr
Parameters
gPUGraphicsPipelinethe value to be wrapped

◆ GPUGraphicsPipeline() [2/2]

SDL::GPUGraphicsPipeline::GPUGraphicsPipeline ( GPUDeviceParam  device,
const GPUGraphicsPipelineCreateInfo createinfo 
)
inline

There are optional properties that can be provided through props. These are the supported properties:

  • prop::GPUGraphicsPipeline.CREATE_NAME_STRING: a name that can be displayed in debugging tools.
Parameters
devicea GPU Context.
createinfoa struct describing the state of the graphics pipeline to create.
Postcondition
a graphics pipeline object on success.
Exceptions
Erroron failure.
Since
This function is available since SDL 3.2.0.
See also
GPUShader.GPUShader
GPURenderPass.BindPipeline
GPUDevice.ReleaseGraphicsPipeline

Member Function Documentation

◆ operator GPUGraphicsPipelineRaw()

constexpr SDL::GPUGraphicsPipeline::operator GPUGraphicsPipelineRaw ( ) const
inlineconstexpr
Returns
the underlying GPUGraphicsPipelineRaw.

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