Frame::FramePass Class Reference

#include <framepass.h>

Inherits Frame::FrameOp.

Classes
struct	CompiledImpl

Public Member Functions
	FramePass ()
	constructor
virtual	~FramePass ()
	destructor
void	Discard () override
	discard operation
void	OnWindowResized () override
	handle display resizing
FrameOp::Compiled *	AllocCompiled (Memory::ArenaAllocator< BIG_CHUNK > &allocator) override
	allocate new instance
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

Public Attributes
CoreGraphics::PassId	pass
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

Private Member Functions
void	Build (const BuildContext &ctx) override
	build operation

Friends
class	FrameScript

Additional Inherited Members
Protected Member Functions inherited from Frame::FrameOp
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

Constructor & Destructor Documentation

FramePass()

Frame::FramePass::FramePass

(

)

constructor

~FramePass()

Frame::FramePass::~FramePass ( )

virtual

destructor

Member Function Documentation

AllocCompiled()

FrameOp::Compiled * Frame::FramePass::AllocCompiled ( Memory::ArenaAllocator< BIG_CHUNK > & allocator )

overridevirtual

allocate new instance

Implements Frame::FrameOp.

Build()

void Frame::FramePass::Build ( const BuildContext & ctx )

overrideprivatevirtual

build operation

Reimplemented from Frame::FrameOp.

Discard()

void Frame::FramePass::Discard ( )

overridevirtual

discard operation

Reimplemented from Frame::FrameOp.

OnWindowResized()

void Frame::FramePass::OnWindowResized ( )

overridevirtual

handle display resizing

Reimplemented from Frame::FrameOp.

Friends And Related Symbol Documentation

FrameScript

friend class FrameScript

friend

Member Data Documentation

pass

CoreGraphics::PassId Frame::FramePass::pass

---

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

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