Vireo  0.0
Vireo 3D Rendering Hardware Interface
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DescriptorLayout Class Referenceabstract

Detailed Description

A descriptor set layout object. Describes resources that shaders can use. Add resources with add() then call build() to build the layout. Note that samplers must be bounds to a specific sampler-only layout.

Manual page : Descriptor Layout

Public Member Functions

virtual DescriptorLayout & add (DescriptorIndex index, DescriptorType type, size_t count=1) = 0
 
virtual void build ()
 
auto getCapacity () const
 
auto isDynamicUniform () const
 
auto isSamplers () const
 
virtual ~DescriptorLayout () = default
 
 DescriptorLayout (DescriptorLayout &) = delete
 
DescriptorLayout & operator= (const DescriptorLayout &) = delete
 

Protected Member Functions

 DescriptorLayout (const bool samplers, const bool dynamic)
 

Protected Attributes

size_t capacity {0}
 
bool samplers {false}
 
bool dynamic {false}
 

Constructor & Destructor Documentation

virtual ~DescriptorLayout ( )
virtualdefault
DescriptorLayout ( DescriptorLayout &  )
delete
DescriptorLayout ( const bool  samplers,
const bool  dynamic 
)
inlineprotected

Member Function Documentation

virtual DescriptorLayout& add ( DescriptorIndex  index,
DescriptorType  type,
size_t  count = 1 
)
pure virtual

Add a resource to the layout

Parameters
indexBinding index
typeType of resource
countNumber of instances
virtual void build ( )
inlinevirtual

Build the layout after adding resource descriptions with add()

auto getCapacity ( ) const
inline

Returns the total number of resources instances

auto isDynamicUniform ( ) const
inline

Returns true if the layout describes one dynamic uniform buffer

auto isSamplers ( ) const
inline

Returns true if the layout is for samplers only

DescriptorLayout& operator= ( const DescriptorLayout &  )
delete

Member Data Documentation

size_t capacity {0}
protected
bool dynamic {false}
protected
bool samplers {false}
protected