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

A custom GPU render state. More...

Inheritance diagram for SDL::GPURenderState:
Inheritance graph
[legend]

Public Member Functions

constexpr GPURenderState ()=default
 Default ctor.
 
constexpr GPURenderState (const GPURenderStateRaw resource)
 Constructs from GPURenderStateParam. More...
 
constexpr GPURenderState (GPURenderState &&other)
 Move constructor.
 
constexpr GPURenderState (const GPURenderStateRef &other)=delete
 
constexpr GPURenderState (GPURenderStateRef &&other)=delete
 
 GPURenderState (RendererParam renderer, GPURenderStateCreateInfo *createinfo)
 Create custom GPU render state. More...
 
 ~GPURenderState ()
 Destructor.
 
GPURenderStateoperator= (GPURenderState other)
 Assignment operator.
 
constexpr GPURenderStateRaw get () const
 Retrieves underlying GPURenderStateRaw.
 
constexpr GPURenderStateRaw release ()
 Retrieves underlying GPURenderStateRaw and clear this.
 
constexpr auto operator<=> (const GPURenderState &other) const =default
 Comparison.
 
constexpr bool operator== (std::nullptr_t _) const
 Comparison.
 
constexpr operator bool () const
 Converts to bool.
 
constexpr operator GPURenderStateParam () const noexcept
 Converts to GPURenderStateParam.
 
void Destroy ()
 Destroy custom GPU render state. More...
 
void SetFragmentUniforms (Uint32 slot_index, const void *data, Uint32 length)
 Set fragment shader uniform variables in a custom GPU render state. More...
 

Protected Member Functions

constexpr GPURenderState (const GPURenderState &other) noexcept=default
 Copy constructor.
 

Detailed Description

Since
This struct is available since SDL 3.4.0.
See also
GPURenderState.GPURenderState
GPURenderState.SetFragmentUniforms
Renderer.SetGPURenderState
GPURenderState.Destroy
Category:
Resource

Constructor & Destructor Documentation

◆ GPURenderState() [1/2]

constexpr SDL::GPURenderState::GPURenderState ( const GPURenderStateRaw  resource)
inlineexplicitconstexpr
Parameters
resourcea GPURenderStateRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

◆ GPURenderState() [2/2]

SDL::GPURenderState::GPURenderState ( RendererParam  renderer,
GPURenderStateCreateInfo createinfo 
)
inline
Parameters
rendererthe renderer to use.
createinfoa struct describing the GPU render state to create.
Postcondition
a custom GPU render state or nullptr on failure; call GetError() for more information.
Thread safety:
This function should be called on the thread that created the renderer.
Since
This function is available since SDL 3.4.0.
See also
GPURenderState.SetFragmentUniforms
Renderer.SetGPURenderState
GPURenderState.Destroy

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