Vireo  0.0
Vireo 3D Rendering Hardware Interface
Public Member Functions | Properties
DescriptorSet Class Referenceabstract

Detailed Description

A bound collection of resources (buffers, images, samplers) for a pipeline. Created by Vireo.create_descriptor_set().

Lua full name: vireo.DescriptorSet

Public Member Functions

nil update_buffer (index: vireo.DescriptorIndex, buffer: Buffer)
 Binds a uniform or storage buffer at the given binding index. More...
 
nil update_dynamic_buffer (buffer: Buffer)
 Binds a dynamic uniform buffer at binding index 0; the byte offset is supplied at bind time. More...
 
nil update_image (index: vireo.DescriptorIndex, image: Image)
 Binds a sampled image or storage image at the given binding index. More...
 
nil update_sampler (index: vireo.DescriptorIndex, sampler: Sampler)
 Binds a sampler at the given binding index. More...
 
nil update_image_array (index: vireo.DescriptorIndex, images: Image[])
 Binds an array of images starting at the given binding index. More...
 
nil update_buffer_array (index: vireo.DescriptorIndex, buffers: Buffer[])
 Binds an array of buffers starting at the given binding index. More...
 
nil update_sampler_array (index: vireo.DescriptorIndex, samplers: Sampler[])
 Binds an array of samplers starting at the given binding index. More...
 

Properties

DescriptorLayout layout
 The DescriptorLayout this set was created from. (read-only)
 

Member Function Documentation

nil update_buffer ( vireo.DescriptorIndex  index,
Buffer  buffer)

Binds a uniform or storage buffer at the given binding index.

Parameters
indexvireo.DescriptorIndex
bufferBuffer
nil update_dynamic_buffer ( Buffer  buffer)

Binds a dynamic uniform buffer at binding index 0; the byte offset is supplied at bind time.

Parameters
bufferBuffer
nil update_image ( vireo.DescriptorIndex  index,
Image  image)

Binds a sampled image or storage image at the given binding index.

Parameters
indexvireo.DescriptorIndex
imageImage
nil update_sampler ( vireo.DescriptorIndex  index,
Sampler  sampler)

Binds a sampler at the given binding index.

Parameters
indexvireo.DescriptorIndex
samplerSampler
nil update_image_array ( vireo.DescriptorIndex  index,
Image[]  images)

Binds an array of images starting at the given binding index.

Parameters
indexvireo.DescriptorIndex
imagesImage[]
nil update_buffer_array ( vireo.DescriptorIndex  index,
Buffer[]  buffers)

Binds an array of buffers starting at the given binding index.

Parameters
indexvireo.DescriptorIndex
buffersBuffer[]
nil update_sampler_array ( vireo.DescriptorIndex  index,
Sampler[]  samplers)

Binds an array of samplers starting at the given binding index.

Parameters
indexvireo.DescriptorIndex
samplersSampler[]

Property Documentation

DescriptorLayout layout

The DescriptorLayout this set was created from. (read-only)