Struct nobs_vulkanism_headless::cmd::Stream

pub struct Stream {
    pub buffer: CommandBuffer,
    // some fields omitted
}

Wrapps a vulkan command buffer

The stream is basically a builder pattern for all vulkan functions related to vk::Cmd*. For every command in commands we can use push to enqueue it to the command stream.

When we are done building the command stream, we push it into a batch (BatchSubmit, AutoBatch, Frame). The batch can then submit all streams with one queue submit call. This is useful, since queue submit calls are very overhead heavy.

Fields

buffer: CommandBuffer

Methods

impl Stream

pub fn new(streams: Arc<Mutex<StreamCache>>) -> Result<Self, Error>

Is only called by Pool

pub fn begin(self) -> Result<Self, Error>

Is implicitly called in Pool::begin_stream

pub fn push<T: StreamPush>(self, o: &T) -> Self

Pushes a command into a stream.

Any struct implementing the StreamPush trait can be pushed into the stream. This can be used to build more complex commands from many primitive ones and be able to push them with one call.

pub fn waive(self)

Returns the stream to the pool.

This breaks up configuring the stream and returns it to the pool. No vulkan commands are submitted, the command buffer can be reused again.