CompileManager is a helper class that compiles subgraphs for the windows/framebuffers associated with the CompileManager. More...

#include <CompileManager.h>

Inheritance diagram for vsg::CompileManager:

[legend]

Collaboration diagram for vsg::CompileManager:

[legend]

Public Types
using	ContextSelectionFunction = std::function< bool(vsg::Context &)>

Public Member Functions
	CompileManager (Viewer &viewer, ref_ptr< ResourceHints > hints)

void	add (ref_ptr< Device > device, const ResourceRequirements &resourceRequirements={})
	add a compile Context for device

void	add (Window &window, ref_ptr< ViewportState > viewport={}, const ResourceRequirements &resourceRequirements={})
	add a compile Context for Window and associated viewport.

void	add (Window &window, ref_ptr< View > view, const ResourceRequirements &resourceRequirements={})
	add a compile Context for View

void	add (Framebuffer &framebuffer, ref_ptr< View > view, const ResourceRequirements &resourceRequirements={})
	add a compile Context for Framebuffer and associated View

void	add (const Viewer &viewer, const ResourceRequirements &resourceRequirements={})
	add a compile Context for all the Views assigned to a Viewer

CompileResult	compile (ref_ptr< Object > object, ContextSelectionFunction contextSelection={})
	compile object

Public Member Functions inherited from vsg::Inherit< Object, CompileManager >
	Inherit (Args &&... args)

std::size_t	sizeofObject () const noexcept override

const char *	className () const noexcept override

const std::type_info &	type_info () const noexcept override

bool	is_compatible (const std::type_info &type) const noexcept override

int	compare (const Object &rhs) const override

void	accept (Visitor &visitor) override

void	accept (ConstVisitor &visitor) const override

void	accept (RecordTraversal &visitor) const override

Public Member Functions inherited from vsg::Object
	Object (const Object &)

Object &	operator= (const Object &)

template<class T >
T *	cast ()

template<class T >
const T *	cast () const

virtual void	traverse (Visitor &)

virtual void	traverse (ConstVisitor &) const

virtual void	traverse (RecordTraversal &) const

virtual void	read (Input &input)

virtual void	write (Output &output) const

void	ref () const noexcept

void	unref () const noexcept

void	unref_nodelete () const noexcept

unsigned int	referenceCount () const noexcept

template<typename T >
void	setValue (const std::string &key, const T &value)

void	setValue (const std::string &key, const char *value)
	specialization of setValue to handle passing C strings

template<typename T >
bool	getValue (const std::string &key, T &value) const
	get specified value type, return false if value associated with key is not assigned or is not the correct type

void	setObject (const std::string &key, ref_ptr< Object > object)
	assign an Object associated with key

Object *	getObject (const std::string &key)
	get Object pointer associated with key, return nullptr if no object associated with key has been assigned

const Object *	getObject (const std::string &key) const
	get const Object pointer associated with key, return nullptr if no object associated with key has been assigned

template<class T >
T *	getObject (const std::string &key)
	get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned

template<class T >
const T *	getObject (const std::string &key) const
	get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned

ref_ptr< Object >	getRefObject (const std::string &key)
	get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned

ref_ptr< const Object >	getRefObject (const std::string &key) const
	get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned

template<class T >
ref_ptr< T >	getRefObject (const std::string &key)
	get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned

template<class T >
const ref_ptr< const T >	getRefObject (const std::string &key) const
	get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned

void	removeObject (const std::string &key)
	remove meta object or value associated with key

Auxiliary *	getOrCreateAuxiliary ()

Auxiliary *	getAuxiliary ()

const Auxiliary *	getAuxiliary () const

Protected Types
using	CompileTraversals = ThreadSafeQueue< ref_ptr< CompileTraversal > >

Protected Member Functions
CompileTraversals::container_type	takeCompileTraversals (size_t count)

Protected Member Functions inherited from vsg::Object
virtual void	_attemptDelete () const

void	setAuxiliary (Auxiliary *auxiliary)

Protected Attributes
size_t	numCompileTraversals = 0

ref_ptr< CompileTraversals >	compileTraversals

Additional Inherited Members
Static Public Member Functions inherited from vsg::Inherit< Object, CompileManager >
static ref_ptr< CompileManager >	create (Args &&... args)

static ref_ptr< CompileManager >	create_if (bool flag, Args &&... args)

Static Public Member Functions inherited from vsg::Object
static ref_ptr< Object >	create ()

static ref_ptr< Object >	create_if (bool flag)

static void *	operator new (std::size_t count)
	provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS

static void	operator delete (void *ptr)

Detailed Description

CompileManager is a helper class that compiles subgraphs for the windows/framebuffers associated with the CompileManager.

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

include/vsg/app/CompileManager.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description