Frame::FrameEvent Class Reference

#include <frameevent.h>

Inherits Frame::FrameOp.

Public Types
enum	Action { Set , Reset , Wait }

Public Member Functions
	FrameEvent ()
	constructor
virtual	~FrameEvent ()
	destructor
void	Discard ()
	discard operation
void	Run (const IndexT frameIndex)
	run operation
Public Member Functions inherited from Frame::FrameOp
	FrameOp ()
	constructor
virtual	~FrameOp ()
	destructor
void	SetName (const Util::StringAtom &name)
	set name
const Util::StringAtom &	GetName () const
	get name
void	SetEnabled (bool b)
	set if operation should be enabled
const bool	GetEnabled () const
	get if operation is enabled
void	AddChild (FrameOp *op)
	add child operation
const Util::Array< Frame::FrameOp * > &	GetChildren ()
	get children
virtual void	OnWindowResized ()
	handle display resizing

Public Attributes
Util::Array< Action >	actions
CoreGraphics::EventId	event
CoreGraphics::PipelineStage	dependency
CoreGraphics::QueueType	queueType
Public Attributes inherited from Frame::FrameOp
CoreGraphics::BarrierDomain	domain
CoreGraphics::QueueType	queue
Util::Dictionary< CoreGraphics::TextureId, Util::Tuple< Util::StringAtom, CoreGraphics::PipelineStage, CoreGraphics::TextureSubresourceInfo > >	textureDeps
Util::Dictionary< CoreGraphics::BufferId, Util::Tuple< Util::StringAtom, CoreGraphics::PipelineStage, CoreGraphics::BufferSubresourceInfo > >	bufferDeps
Util::Dictionary< const CoreGraphics::TextureId *, Util::Tuple< Util::StringAtom, CoreGraphics::PipelineStage, CoreGraphics::TextureSubresourceInfo > >	textureDepRefs
Util::Dictionary< const CoreGraphics::BufferId *, Util::Tuple< Util::StringAtom, CoreGraphics::PipelineStage, CoreGraphics::BufferSubresourceInfo > >	bufferDepRefs

Additional Inherited Members
Protected Member Functions inherited from Frame::FrameOp
virtual Compiled *	AllocCompiled (Memory::ArenaAllocator< BIG_CHUNK > &allocator)=0
	allocate instance of compiled
virtual void	Build (const BuildContext &ctx)
	build operation
void	SetupSynchronization (Memory::ArenaAllocator< BIG_CHUNK > &allocator, Util::Array< CoreGraphics::EventId > &events, Util::Array< CoreGraphics::BarrierId > &barriers, Util::Dictionary< CoreGraphics::BufferId, Util::Array< BufferDependency > > &buffers, Util::Dictionary< CoreGraphics::TextureId, Util::Array< TextureDependency > > &textures)
	setup synchronization
Static Protected Member Functions inherited from Frame::FrameOp
static void	AnalyzeAndSetupTextureBarriers (struct FrameOp::Compiled *op, CoreGraphics::TextureId tex, const Util::StringAtom &textureName, DependencyIntent readOrWrite, CoreGraphics::PipelineStage stage, CoreGraphics::BarrierDomain domain, const CoreGraphics::TextureSubresourceInfo &subres, CoreGraphics::QueueType fromQueue, Util::Dictionary< Util::Tuple< CoreGraphics::PipelineStage, CoreGraphics::PipelineStage >, CoreGraphics::BarrierCreateInfo > &barriers, Util::Dictionary< Util::Tuple< CoreGraphics::PipelineStage, CoreGraphics::PipelineStage >, CoreGraphics::EventCreateInfo > &waitEvents, Util::Dictionary< Util::Tuple< CoreGraphics::PipelineStage, CoreGraphics::PipelineStage >, struct FrameOp::Compiled * > &signalEvents, Util::Array< FrameOp::TextureDependency > &renderTextureDependencies)
	Analyze and setup barriers if needed.
static void	AnalyzeAndSetupBufferBarriers (struct FrameOp::Compiled *op, CoreGraphics::BufferId buf, const Util::StringAtom &bufferName, DependencyIntent readOrWrite, CoreGraphics::PipelineStage stage, CoreGraphics::BarrierDomain domain, const CoreGraphics::BufferSubresourceInfo &subres, CoreGraphics::QueueType fromQueue, Util::Dictionary< Util::Tuple< CoreGraphics::PipelineStage, CoreGraphics::PipelineStage >, CoreGraphics::BarrierCreateInfo > &barriers, Util::Dictionary< Util::Tuple< CoreGraphics::PipelineStage, CoreGraphics::PipelineStage >, CoreGraphics::EventCreateInfo > &waitEvents, Util::Dictionary< Util::Tuple< CoreGraphics::PipelineStage, CoreGraphics::PipelineStage >, struct FrameOp::Compiled * > &signalEvents, Util::Array< FrameOp::BufferDependency > &bufferDependencies)
Protected Attributes inherited from Frame::FrameOp
Util::Array< FrameOp * >	children
Util::Dictionary< Util::StringAtom, FrameOp * >	childrenByName
Compiled *	compiled
Util::StringAtom	name
IndexT	index
bool	enabled

Member Enumeration Documentation

Action

enum Frame::FrameEvent::Action

Enumerator
Set
Reset
Wait

Constructor & Destructor Documentation

FrameEvent()

Frame::FrameEvent::FrameEvent

(

)

constructor

~FrameEvent()

Frame::FrameEvent::~FrameEvent ( )

virtual

destructor

Member Function Documentation

Discard()

void Frame::FrameEvent::Discard ( )

virtual

discard operation

Reimplemented from Frame::FrameOp.

Run()

void Frame::FrameEvent::Run

(

const IndexT

frameIndex

)

run operation

Member Data Documentation

actions

Util::Array<Action> Frame::FrameEvent::actions

dependency

CoreGraphics::PipelineStage Frame::FrameEvent::dependency

event

CoreGraphics::EventId Frame::FrameEvent::event

queueType

CoreGraphics::QueueType Frame::FrameEvent::queueType

---

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

• /github/workspace/code/render/frame/frameevent.h
• /github/workspace/code/render/frame/frameevent.cc