SDL::GPUCopyPass Class Reference

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

Public Member Functions
constexpr	GPUCopyPass (GPUCopyPassRaw gPUCopyPass={}) noexcept
	Wraps GPUCopyPass.
constexpr	operator GPUCopyPassRaw () const noexcept
	Unwraps to the underlying GPUCopyPass.
void	UploadToTexture (const GPUTextureTransferInfo &source, const GPUTextureRegion &destination, bool cycle)
	Uploads data from a transfer buffer to a texture.
void	UploadToBuffer (const GPUTransferBufferLocation &source, const GPUBufferRegion &destination, bool cycle)
	Uploads data from a transfer buffer to a buffer.
void	CopyTextureToTexture (const GPUTextureLocation &source, const GPUTextureLocation &destination, Uint32 w, Uint32 h, Uint32 d, bool cycle)
	Performs a texture-to-texture copy.
void	CopyBufferToBuffer (const GPUBufferLocation &source, const GPUBufferLocation &destination, Uint32 size, bool cycle)
	Performs a buffer-to-buffer copy.
void	DownloadFromTexture (const GPUTextureRegion &source, const GPUTextureTransferInfo &destination)
	Copies data from a texture to a transfer buffer on the GPU timeline.
void	DownloadFromBuffer (const GPUBufferRegion &source, const GPUTransferBufferLocation &destination)
	Copies data from a buffer to a transfer buffer on the GPU timeline.
void	End ()
	Ends the current copy pass.

Detailed Description

An opaque handle representing a copy pass.

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

Since

This struct is available since SDL 3.2.0.

See also

GPUCommandBuffer.BeginCopyPass

GPUCopyPass.End

Constructor & Destructor Documentation

GPUCopyPass()

SDL::GPUCopyPass::GPUCopyPass ( GPUCopyPassRaw gPUCopyPass = {} )

inlineconstexprnoexcept

Wraps GPUCopyPass.

Parameters

gPUCopyPass

the value to be wrapped

Member Function Documentation

operator GPUCopyPassRaw()

SDL::GPUCopyPass::operator GPUCopyPassRaw ( ) const

inlineconstexprnoexcept

Unwraps to the underlying GPUCopyPass.

Returns

the underlying GPUCopyPassRaw.

---

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

• SDL3pp/SDL3pp_gpu.h