Faro Engine 0.0.0.b519570 (main)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
Faro::GraphicsCommandList Class Referenceabstract

#include <GraphicsCommandList.hpp>

Inheritance diagram for Faro::GraphicsCommandList:
Faro::IGraphicsAdapterChild Faro::IObject Faro::GraphicsCommandListVK

Public Member Functions

virtual void Reset ()=0
 
virtual void Execute (Array< GraphicsSemaphore * > waitForSemaphores={})=0
 
virtual void SetResourceState (GraphicsBuffer *buffer, GraphicsResourceState state)=0
 
virtual void CopyBuffer (GraphicsBuffer *source, GraphicsBuffer *destination)=0
 
virtual void ClearRenderTarget (GraphicsBuffer *renderTarget, FloatColor color)=0
 
void Init (GraphicsAdapter *adapter)
 Initialize this as a child object for an adapter. Also invokes IObject::Init, derived classes should use that for initialization.
 
GraphicsAdapterGetAdapter ()
 
template<class T >
T * GetTypedAdapter ()
 
virtual void Destroy ()
 Run the destruction logic of this class. This also frees its memory.
 

Protected Member Functions

void Init () override
 Run the initialization logic of this object. Should be overriden by deriving classes.
 

Member Function Documentation

◆ ClearRenderTarget()

virtual void Faro::GraphicsCommandList::ClearRenderTarget ( GraphicsBuffer renderTarget,
FloatColor  color 
)
pure virtual

Implemented in Faro::GraphicsCommandListVK.

◆ CopyBuffer()

virtual void Faro::GraphicsCommandList::CopyBuffer ( GraphicsBuffer source,
GraphicsBuffer destination 
)
pure virtual

Implemented in Faro::GraphicsCommandListVK.

◆ Destroy()

void Faro::IObject::Destroy ( )
virtualinherited

Run the destruction logic of this class. This also frees its memory.

Warning
When overriding, the super call must be performed last

Reimplemented in Faro::DataStream, Faro::DataStreamCopy, Faro::GraphicsBufferContainer, Faro::GraphicsSwapchain, Faro::GraphicsBufferVK, Faro::GraphicsCommandListVK, Faro::GraphicsFenceVK, Faro::GraphicsPipelineVK, Faro::GraphicsSemaphoreVK, and Faro::GraphicsSwapchainVK.

◆ Execute()

virtual void Faro::GraphicsCommandList::Execute ( Array< GraphicsSemaphore * >  waitForSemaphores = {})
pure virtual

Implemented in Faro::GraphicsCommandListVK.

◆ GetAdapter()

GraphicsAdapter * Faro::IGraphicsAdapterChild::GetAdapter ( )
inherited

◆ GetTypedAdapter()

template<class T >
T * Faro::IGraphicsAdapterChild::GetTypedAdapter ( )
inlineinherited

◆ Init() [1/2]

void Faro::IGraphicsAdapterChild::Init ( )
overrideprotectedvirtualinherited

Run the initialization logic of this object. Should be overriden by deriving classes.

Reimplemented from Faro::IObject.

◆ Init() [2/2]

void Faro::IGraphicsAdapterChild::Init ( GraphicsAdapter adapter)
inherited

Initialize this as a child object for an adapter. Also invokes IObject::Init, derived classes should use that for initialization.

Parameters
adapterGraphics adapter to initialize this child on.

◆ Reset()

virtual void Faro::GraphicsCommandList::Reset ( )
pure virtual

Implemented in Faro::GraphicsCommandListVK.

◆ SetResourceState()

virtual void Faro::GraphicsCommandList::SetResourceState ( GraphicsBuffer buffer,
GraphicsResourceState  state 
)
pure virtual

Implemented in Faro::GraphicsCommandListVK.


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