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

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

Public Member Functions

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

Detailed Description

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()

constexpr SDL::GPUCopyPass::GPUCopyPass ( GPUCopyPassRaw  gPUCopyPass = {})
inlineconstexpr
Parameters
gPUCopyPassthe value to be wrapped

Member Function Documentation

◆ operator GPUCopyPassRaw()

constexpr SDL::GPUCopyPass::operator GPUCopyPassRaw ( ) const
inlineconstexpr
Returns
the underlying GPUCopyPassRaw.

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