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

Hydra Graphics Interface. More...

+ Inheritance diagram for Hgi:

Public Member Functions

virtual HGI_API
HgiImmediateCommandBuffer
GetImmediateCommandBuffer ()=0
 Returns the immediate command buffer. More...
 
virtual HGI_API HgiTextureHandle CreateTexture (HgiTextureDesc const &desc)=0
 Create a texture in rendering backend. More...
 
virtual HGI_API void DestroyTexture (HgiTextureHandle *texHandle)=0
 Destroy a texture in rendering backend. More...
 

Detailed Description

Hydra Graphics Interface.

Hgi is used to communicate with one or more physical gpu devices.

Hgi provides API to create/destroy resources that a gpu device owns. The lifetime of resources is not managed by Hgi, so it is up to the caller to destroy resources and ensure those resources are no longer used.

Commands are recorded via an encoder that is acquired from a command buffer. Command buffers can work in immediate or deferred mode. An immediate command buffer assumes its encoders will execute commands without delay in the graphics backend. A deferred command buffer records commands to be executed at a later time in the graphics backend.

XXX We currently only support one immediate command buffer since most code in HdSt was written via OpenGL's immediate style API.

Definition at line 56 of file hgi.h.

Member Function Documentation

virtual HGI_API HgiTextureHandle CreateTexture ( HgiTextureDesc const &  desc)
pure virtual

Create a texture in rendering backend.

Implemented in HgiGL.

virtual HGI_API void DestroyTexture ( HgiTextureHandle *  texHandle)
pure virtual

Destroy a texture in rendering backend.

Implemented in HgiGL.

virtual HGI_API HgiImmediateCommandBuffer& GetImmediateCommandBuffer ( )
pure virtual

Returns the immediate command buffer.

Implemented in HgiGL.


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