Struct vulkano::command_buffer::StateCacher
source · pub struct StateCacher { /* private fields */ }
Expand description
Keep track of the state of a command buffer builder, so that you don’t need to bind objects that were already bound.
Important: Executing a secondary command buffer invalidates the state of a command buffer builder. When you do so, you need to call
invalidate()
.
Implementations
sourceimpl StateCacher
impl StateCacher
sourcepub fn new() -> StateCacher
pub fn new() -> StateCacher
Builds a new StateCacher
.
sourcepub fn invalidate(&mut self)
pub fn invalidate(&mut self)
Resets the cache to its default state. You must call this after executing a secondary command buffer.
sourcepub fn dynamic_state(&mut self, incoming: &DynamicState) -> DynamicState
pub fn dynamic_state(&mut self, incoming: &DynamicState) -> DynamicState
Compares the current state with incoming
, and returns a new state that contains the
states that differ and that need to be actually set in the command buffer builder.
This function also updates the state cacher. The state cacher assumes that the state changes are going to be performed after this function returns.
sourcepub fn bind_descriptor_sets(
&mut self,
graphics: bool
) -> StateCacherDescriptorSets<'_>
pub fn bind_descriptor_sets(
&mut self,
graphics: bool
) -> StateCacherDescriptorSets<'_>
Starts the process of comparing a list of descriptor sets to the descriptor sets currently in cache.
After calling this function, call add
for each set one by one. Then call compare
in
order to get the index of the first set to bind, or None
if the sets were identical to
what is in cache.
This process also updates the state cacher. The state cacher assumes that the state
changes are going to be performed after the compare
function returns.
sourcepub fn bind_graphics_pipeline<P>(&mut self, pipeline: &P) -> StateCacherOutcomewhere
P: GraphicsPipelineAbstract,
pub fn bind_graphics_pipeline<P>(&mut self, pipeline: &P) -> StateCacherOutcomewhere
P: GraphicsPipelineAbstract,
Checks whether we need to bind a graphics pipeline. Returns StateCacherOutcome::AlreadyOk
if the pipeline was already bound earlier, and StateCacherOutcome::NeedChange
if you need
to actually bind the pipeline.
This function also updates the state cacher. The state cacher assumes that the state changes are going to be performed after this function returns.
sourcepub fn bind_compute_pipeline<P>(&mut self, pipeline: &P) -> StateCacherOutcomewhere
P: ComputePipelineAbstract,
pub fn bind_compute_pipeline<P>(&mut self, pipeline: &P) -> StateCacherOutcomewhere
P: ComputePipelineAbstract,
Checks whether we need to bind a compute pipeline. Returns StateCacherOutcome::AlreadyOk
if the pipeline was already bound earlier, and StateCacherOutcome::NeedChange
if you need
to actually bind the pipeline.
This function also updates the state cacher. The state cacher assumes that the state changes are going to be performed after this function returns.
sourcepub fn bind_vertex_buffers(&mut self) -> StateCacherVertexBuffers<'_>
pub fn bind_vertex_buffers(&mut self) -> StateCacherVertexBuffers<'_>
Starts the process of comparing a list of vertex buffers to the vertex buffers currently in cache.
After calling this function, call add
for each set one by one. Then call compare
in
order to get the range of the vertex buffers to bind, or None
if the sets were identical
to what is in cache.
This process also updates the state cacher. The state cacher assumes that the state
changes are going to be performed after the compare
function returns.
sourcepub fn bind_index_buffer<B>(
&mut self,
index_buffer: &B,
ty: IndexType
) -> StateCacherOutcomewhere
B: ?Sized + BufferAccess,
pub fn bind_index_buffer<B>(
&mut self,
index_buffer: &B,
ty: IndexType
) -> StateCacherOutcomewhere
B: ?Sized + BufferAccess,
Checks whether we need to bind an index buffer. Returns StateCacherOutcome::AlreadyOk
if the index buffer was already bound earlier, and StateCacherOutcome::NeedChange
if you
need to actually bind the buffer.
This function also updates the state cacher. The state cacher assumes that the state changes are going to be performed after this function returns.