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

A graphics API independent abstraction of graphics commands. More...

+ Inheritance diagram for HgiGraphicsEncoder:

Public Member Functions

virtual HGI_API void EndEncoding ()=0
 Finish recording of commands. No further commands can be recorded. More...
 
virtual HGI_API void SetViewport (GfVec4i const &vp)=0
 Set viewport [left, BOTTOM, width, height] - OpenGL coords. More...
 
virtual HGI_API void PushDebugGroup (const char *label)=0
 Push a debug marker onto the encoder. More...
 
virtual HGI_API void PopDebugGroup ()=0
 Pop the lastest debug marker off encoder. More...
 

Detailed Description

A graphics API independent abstraction of graphics commands.

HgiGraphicsEncoder is a lightweight object that cannot be re-used after EndEncoding. A new encoder should be acquired from CommandBuffer each frame.

The API provided by this encoder should be agnostic to whether the encoder operates via immediate or deferred command buffers.

Definition at line 42 of file graphicsEncoder.h.

Member Function Documentation

virtual HGI_API void EndEncoding ( )
pure virtual

Finish recording of commands. No further commands can be recorded.

Implemented in HgiGLGraphicsEncoder.

virtual HGI_API void PopDebugGroup ( )
pure virtual

Pop the lastest debug marker off encoder.

Implemented in HgiGLGraphicsEncoder.

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

Push a debug marker onto the encoder.

Implemented in HgiGLGraphicsEncoder.

virtual HGI_API void SetViewport ( GfVec4i const &  vp)
pure virtual

Set viewport [left, BOTTOM, width, height] - OpenGL coords.

Implemented in HgiGLGraphicsEncoder.


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