dw::framework::PassCollectionDescriptor Class Reference

Detailed Description

A collection of pass descriptors.

Definition at line 80 of file PassCollectionDescriptor.hpp.

Public Member Functions
void	addDescriptor (const PassDescriptor &descriptor)
const PassDescriptor &	getDescriptor (dw::core::StringView const &identifier) const
const PassDescriptor &	getDescriptor (size_t const index) const
	Get the pass descriptor for the passed index. More...
size_t	getIndex (dw::core::StringView const &identifier) const
size_t	getSize () const
	Get the number of pass descriptors. More...
bool	isValid (dw::core::StringView const &identifier) const noexcept
	Check if the passed pass name matches a pass descriptor in the collection. More...
bool	isValid (size_t const index) const noexcept
	Check if the passed index is valid, which mean is within [0, size()). More...
	PassCollectionDescriptor (size_t const capacity)
	Constructor. More...

Constructor & Destructor Documentation

PassCollectionDescriptor()

dw::framework::PassCollectionDescriptor::PassCollectionDescriptor ( size_t const  capacity )

explicit

Constructor.

Member Function Documentation

addDescriptor()

void dw::framework::PassCollectionDescriptor::addDescriptor

(

const PassDescriptor &

descriptor

)

Add a pass descriptor to the collection.

Exceptions

Exception

if the same pass descriptor is already in the collection or the collection is already at capacity

getDescriptor() [1/2]

const PassDescriptor & dw::framework::PassCollectionDescriptor::getDescriptor

(

dw::core::StringView const &

identifier

)

const

Get the pass descriptor with the passed name.

Exceptions

Exception

if a pass descriptor with the passed name isn't in the collection

getDescriptor() [2/2]

const PassDescriptor & dw::framework::PassCollectionDescriptor::getDescriptor

(

size_t const

index

)

const

Get the pass descriptor for the passed index.

getIndex()

size_t dw::framework::PassCollectionDescriptor::getIndex

(

dw::core::StringView const &

identifier

)

const

Get the index of the pass descriptor with the passed name.

Exceptions

Exception

if a pass descriptor with the passed name isn't in the collection

getSize()

size_t dw::framework::PassCollectionDescriptor::getSize

(

)

const

Get the number of pass descriptors.

isValid() [1/2]

bool dw::framework::PassCollectionDescriptor::isValid ( dw::core::StringView const &  identifier ) const

noexcept

Check if the passed pass name matches a pass descriptor in the collection.

isValid() [2/2]

bool dw::framework::PassCollectionDescriptor::isValid ( size_t const  index ) const

noexcept

Check if the passed index is valid, which mean is within [0, size()).

---

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

• src/dwcgf/core/dwcgf/pass/PassCollectionDescriptor.hpp