SDL::GPUSampler Class Reference

An opaque handle representing a sampler. More...

Public Member Functions
constexpr	GPUSampler (GPUSamplerRaw gPUSampler={})
	Wraps GPUSampler. More...
	GPUSampler (GPUDeviceParam device, const GPUSamplerCreateInfo &createinfo)
	Creates a sampler object to be used when binding textures in a graphics workflow. More...
constexpr bool	operator== (const GPUSampler &other) const =default
	Default comparison operator.
constexpr bool	operator== (GPUSamplerRaw gPUSampler) const
	Compares with the underlying type.
constexpr	operator GPUSamplerRaw () const
	Unwraps to the underlying GPUSampler. More...

Detailed Description

Since

This struct is available since SDL 3.2.0.

See also

GPUSampler.GPUSampler

GPURenderPass.BindVertexSamplers

GPURenderPass.BindFragmentSamplers

GPUDevice.ReleaseSampler

Constructor & Destructor Documentation

GPUSampler() [1/2]

constexpr SDL::GPUSampler::GPUSampler ( GPUSamplerRaw  gPUSampler = {} )

inlineconstexpr

Parameters

gPUSampler

the value to be wrapped

GPUSampler() [2/2]

SDL::GPUSampler::GPUSampler ( GPUDeviceParam  device, const GPUSamplerCreateInfo &  createinfo  )

inline

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

• prop::GPUSampler.CREATE_NAME_STRING: a name that can be displayed in debugging tools.

Parameters

device	a GPU Context.
createinfo	a struct describing the state of the sampler to create.

Postcondition

a sampler object on success.

Exceptions

Error

on failure.

Since

This function is available since SDL 3.2.0.

See also

GPURenderPass.BindVertexSamplers

GPURenderPass.BindFragmentSamplers

GPUDevice.ReleaseSampler

Member Function Documentation

operator GPUSamplerRaw()

constexpr SDL::GPUSampler::operator GPUSamplerRaw ( ) const

inlineconstexpr

Returns

the underlying GPUSamplerRaw.

---

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

• SDL3pp/SDL3pp_gpu.h