Struct vulkano::command_buffer::commands_raw::CmdDispatchRaw

pub struct CmdDispatchRaw { /* fields omitted */ }

Command that executes a compute shader.

Note: Unless you are writing a custom implementation of a command buffer, you are encouraged to ignore this struct and use a CmdDispatch instead.

Methods

impl CmdDispatchRaw

unsafe fn new(
    device: Arc<Device>,
    dimensions: [u32; 3]
) -> Result<CmdDispatchRaw, CmdDispatchRawError>

Builds a new command that executes a compute shader.

The command will use the descriptor sets, push constants, and pipeline currently bound.

This function checks whether the dimensions are supported by the device. It returns an error if they are not.

Safety

While building the command is always safe, care must be taken when it is added to a command buffer. A correct combination of compute pipeline, descriptor set and push constants must have been bound beforehand.

unsafe fn unchecked_dimensions(
    device: Arc<Device>,
    dimensions: [u32; 3]
) -> Result<CmdDispatchRaw, CmdDispatchRawError>

Builds a new command that executes a compute shader.

The command will use the descriptor sets, push constants, and pipeline currently bound.

Contrary to new, this function doesn't check whether the dimensions are supported by the device. It always succeeds.

Safety

See the documentation of new. Contrary to new, the dimensions are not checked by this function. It is illegal to build a command with dimensions that are not supported by the device.

Trait Implementations

impl DeviceOwned for CmdDispatchRaw

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.