HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HgiBlitCmds Class Referenceabstract

#include <blitCmds.h>

+ Inheritance diagram for HgiBlitCmds:

Public Member Functions

HGI_API ~HgiBlitCmds () override
 
virtual HGI_API void PushDebugGroup (const char *label)=0
 Push a debug marker. More...
 
virtual HGI_API void PopDebugGroup ()=0
 Pop the lastest debug. More...
 
virtual HGI_API void CopyTextureGpuToCpu (HgiTextureGpuToCpuOp const &copyOp)=0
 
virtual HGI_API void CopyBufferGpuToGpu (HgiBufferGpuToGpuOp const &copyOp)=0
 Copy a buffer resource from GPU to GPU. More...
 
virtual HGI_API void CopyBufferCpuToGpu (HgiBufferCpuToGpuOp const &copyOp)=0
 
virtual HGI_API void GenerateMipMaps (HgiTextureHandle const &texture)=0
 Generate mip maps for a texture. More...
 
- Public Member Functions inherited from HgiCmds
virtual HGI_API ~HgiCmds ()
 

Protected Member Functions

HGI_API HgiBlitCmds ()
 
- Protected Member Functions inherited from HgiCmds
HGI_API HgiCmds ()
 
virtual HGI_API bool _Submit (Hgi *hgi)
 

Detailed Description

A graphics API independent abstraction of resource copy commands. HgiBlitCmds is a lightweight object that cannot be re-used after it has been submitted. A new cmds object should be acquired for each frame.

Definition at line 49 of file blitCmds.h.

Constructor & Destructor Documentation

HGI_API HgiBlitCmds::~HgiBlitCmds ( )
override
HGI_API HgiBlitCmds::HgiBlitCmds ( )
protected

Member Function Documentation

virtual HGI_API void HgiBlitCmds::CopyBufferCpuToGpu ( HgiBufferCpuToGpuOp const copyOp)
pure virtual

Copy new data from cpu into gpu buffer. For example copy new data into a uniform block or storage buffer.

Implemented in HgiGLBlitCmds.

virtual HGI_API void HgiBlitCmds::CopyBufferGpuToGpu ( HgiBufferGpuToGpuOp const copyOp)
pure virtual

Copy a buffer resource from GPU to GPU.

Implemented in HgiGLBlitCmds.

virtual HGI_API void HgiBlitCmds::CopyTextureGpuToCpu ( HgiTextureGpuToCpuOp const copyOp)
pure virtual

Copy a texture resource from GPU to CPU. This call is blocking until the data is ready to be read on CPU.

Implemented in HgiGLBlitCmds.

virtual HGI_API void HgiBlitCmds::GenerateMipMaps ( HgiTextureHandle const texture)
pure virtual

Generate mip maps for a texture.

Implemented in HgiGLBlitCmds.

virtual HGI_API void HgiBlitCmds::PopDebugGroup ( )
pure virtual

Pop the lastest debug.

Implemented in HgiGLBlitCmds.

virtual HGI_API void HgiBlitCmds::PushDebugGroup ( const char *  label)
pure virtual

Push a debug marker.

Implemented in HgiGLBlitCmds.


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