Castor3D 0.16.0
Multiplatform 3D engine
Public Member Functions | List of all members
castor3d::GpuFrameEvent Class Referenceabstract

#include <GpuFrameEvent.hpp>

Inheritance diagram for castor3d::GpuFrameEvent:
Inheritance graph
[legend]

Public Member Functions

C3D_API GpuFrameEvent (GpuFrameEvent const &rhs)
 
C3D_API GpuFrameEvent (GpuFrameEvent &&rhs) noexcept
 
C3D_API GpuFrameEventoperator= (GpuFrameEvent const &rhs)
 
C3D_API GpuFrameEventoperator= (GpuFrameEvent &&rhs) noexcept
 
C3D_API GpuFrameEvent (GpuEventType type)
 Constructor.
 
virtual C3D_API ~GpuFrameEvent () noexcept=default
 Destructor.
 
void apply (RenderDevice const &device, QueueData const &queueData)
 Applies the event.
 
GpuEventType getType () const
 
void skip ()
 Sets the event to be skipped.
 

Constructor & Destructor Documentation

◆ GpuFrameEvent() [1/3]

C3D_API castor3d::GpuFrameEvent::GpuFrameEvent ( GpuFrameEvent const & rhs)

◆ GpuFrameEvent() [2/3]

C3D_API castor3d::GpuFrameEvent::GpuFrameEvent ( GpuFrameEvent && rhs)
noexcept

◆ GpuFrameEvent() [3/3]

C3D_API castor3d::GpuFrameEvent::GpuFrameEvent ( GpuEventType type)
explicit

Constructor.

Parameters
[in]typeThe event type.

◆ ~GpuFrameEvent()

virtual C3D_API castor3d::GpuFrameEvent::~GpuFrameEvent ( )
virtualdefaultnoexcept

Destructor.

Member Function Documentation

◆ apply()

void castor3d::GpuFrameEvent::apply ( RenderDevice const & device,
QueueData const & queueData )
inline

Applies the event.

Parameters
[in]deviceThe GPU device.
[in]queueDataThe queue receiving the GPU commands.

◆ getType()

GpuEventType castor3d::GpuFrameEvent::getType ( ) const
inline
Returns
The event type.

◆ operator=() [1/2]

C3D_API GpuFrameEvent & castor3d::GpuFrameEvent::operator= ( GpuFrameEvent && rhs)
noexcept

◆ operator=() [2/2]

C3D_API GpuFrameEvent & castor3d::GpuFrameEvent::operator= ( GpuFrameEvent const & rhs)

◆ skip()

void castor3d::GpuFrameEvent::skip ( )
inline

Sets the event to be skipped.


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