Struct PipelineCommand 

pub struct PipelineCommand<'c, T> { /* private fields */ }

A Command which has been bound to a particular compute, graphics, or ray tracing pipeline.

Implementations

impl PipelineCommand<'_, ComputePipeline>

pub fn record_cmd( self, func: impl FnOnce(ComputeCommandRef<'_>) + Send + 'static, ) -> Self

Begin recording compute pipeline work for this graph command.

pub fn record_cmd_mut( &mut self, func: impl FnOnce(ComputeCommandRef<'_>) + Send + 'static, )

Mutable-borrow form of Self::record_cmd.

impl PipelineCommand<'_, GraphicsPipeline>

pub fn color_attachment_image( self, color_attachment: u32, image: impl Into<AnyImageNode>, load: LoadOp<ClearColorValue>, store: StoreOp, ) -> Self

Sets the color_attachment attachment index of the following render pass to the given image.

Note: To use multi-sampled (MSAA) rendering, use an image created with a sample count greater than one.

Note: The default view (the whole image) is used for image.

See Render Pass.

pub fn color_attachment_image_view( self, color_attachment: u32, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, load: LoadOp<ClearColorValue>, store: StoreOp, ) -> Self

Sets the color_attachment attachment index of the following render pass to the given image, as interpreted by image_view_info.

See Render Pass.

pub fn color_attachment_resolve_image( self, msaa_attachment: u32, color_attachment: u32, image: impl Into<AnyImageNode>, ) -> Self

Resolves a multi-sampled (MSAA) color image attachment into a single-sampled attachment using the given image.

Note: The default view (the whole image) is used for image.

See Render Pass.

pub fn color_attachment_resolve_image_view( self, msaa_attachment: u32, color_attachment: u32, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, ) -> Self

Resolves a multi-sampled (MSAA) color image attachment into a single-sampled attachment using the given image, as interpreted by image_view_info.

See Render Pass.

pub fn depth_stencil(self, depth_stencil: impl Into<DepthStencilInfo>) -> Self

Sets the combined depth and stencil state used by any subsequent command buffer recordings of the current graph command.

pub fn depth_stencil_attachment_image( self, image: impl Into<AnyImageNode>, load: LoadOp<ClearDepthStencilValue>, store: StoreOp, ) -> Self

Sets the combined depth and stencil attachment of the following render pass to the given image.

Note: To use multi-sampled (MSAA) rendering, use an image created with a sample count greater than one.

Note: The default view (the whole image) is used for image.

See Render Pass.

pub fn depth_stencil_attachment_image_view( self, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, load: LoadOp<ClearDepthStencilValue>, store: StoreOp, ) -> Self

Sets the combined depth and stencil attachment of the following render pass to the given image, as interpreted by image_view_info.

Note: To use multi-sampled (MSAA) rendering, use an image created with a sample count greater than one.

Note: The default view (the whole image) is used for image.

See Render Pass.

pub fn depth_stencil_attachment_resolve_image( self, depth_stencil_attachment: u32, image: impl Into<AnyImageNode>, depth_mode: Option<ResolveMode>, stencil_mode: Option<ResolveMode>, ) -> Self

Resolves a multi-sampled (MSAA) combined depth and stencil image attachment into a single-sampled attachment using the given image.

Note: The default view (the whole image) is used for image.

See Render Pass.

pub fn depth_stencil_attachment_resolve_image_view( self, depth_stencil_attachment: u32, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, depth_mode: Option<ResolveMode>, stencil_mode: Option<ResolveMode>, ) -> Self

Resolves a multi-sampled (MSAA) combined depth and stencil image attachment into a single-sampled attachment using the given image, as interpreted by image_view_info.

Note: The default view (the whole image) is used for image.

See Render Pass.

pub fn multiview(self, view_mask: u32, correlated_view_mask: u32) -> Self

Sets multiview view and correlation masks used by any subsequent command buffer recordings of the current graph command.

See VkRenderPassMultiviewCreateInfo.

pub fn record_cmd( self, func: impl FnOnce(GraphicsCommandRef<'_>) + Send + 'static, ) -> Self

Begin recording graphics pipeline work for this graph command.

pub fn record_cmd_mut( &mut self, func: impl FnOnce(GraphicsCommandRef<'_>) + Send + 'static, )

Mutable-borrow form of Self::record_cmd.

pub fn render_area(self, area: Rect2D) -> Self

Sets the render area used when beginning the render pass for subsequent command buffer recordings of the current graph command.

See VkRenderPassBeginInfo.

NOTE: Setting this value will cause the viewport and scissor to be unset, which is not the default behavior. When this value is set you should call set_viewport and set_scissor on the command buffer.

If not set, this value defaults to the first loaded, resolved, or stored attachment dimensions and sets the viewport and scissor to the same values, with a 0..1 depth if not specified by depth_stencil.

pub fn set_color_attachment_image( &mut self, color_attachment: u32, image: impl Into<AnyImageNode>, load: LoadOp<ClearColorValue>, store: StoreOp, ) -> &mut Self

Mutable-borrow form of Self::color_attachment_image.

pub fn set_color_attachment_image_view( &mut self, color_attachment: u32, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, load: LoadOp<ClearColorValue>, store: StoreOp, ) -> &mut Self

Mutable-borrow form of Self::color_attachment_image_view.

pub fn set_color_attachment_resolve_image( &mut self, msaa_attachment: u32, color_attachment: u32, image: impl Into<AnyImageNode>, ) -> &mut Self

Mutable-borrow form of Self::color_attachment_resolve_image.

pub fn set_color_attachment_resolve_image_view( &mut self, msaa_attachment: u32, color_attachment: u32, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, ) -> &mut Self

Mutable-borrow form of Self::color_attachment_resolve_image_view.

pub fn set_depth_stencil( &mut self, depth_stencil: impl Into<DepthStencilInfo>, ) -> &mut Self

Mutable-borrow form of Self::depth_stencil.

pub fn set_depth_stencil_attachment_image( &mut self, image: impl Into<AnyImageNode>, load: LoadOp<ClearDepthStencilValue>, store: StoreOp, ) -> &mut Self

Mutable-borrow form of Self::depth_stencil_attachment_image.

pub fn set_depth_stencil_attachment_image_view( &mut self, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, load: LoadOp<ClearDepthStencilValue>, store: StoreOp, ) -> &mut Self

Mutable-borrow form of Self::depth_stencil_attachment_image_view.

pub fn set_depth_stencil_attachment_resolve_image( &mut self, depth_stencil_attachment: u32, image: impl Into<AnyImageNode>, depth_mode: Option<ResolveMode>, stencil_mode: Option<ResolveMode>, ) -> &mut Self

Mutable-borrow form of Self::depth_stencil_attachment_resolve_image.

pub fn set_depth_stencil_attachment_resolve_image_view( &mut self, depth_stencil_attachment: u32, image: impl Into<AnyImageNode>, image_view_info: impl Into<ImageViewInfo>, depth_mode: Option<ResolveMode>, stencil_mode: Option<ResolveMode>, ) -> &mut Self

Mutable-borrow form of Self::depth_stencil_attachment_resolve_image_view.

pub fn set_multiview( &mut self, view_mask: u32, correlated_view_mask: u32, ) -> &mut Self

Mutable-borrow form of Self::multiview.

pub fn set_render_area(&mut self, area: Rect2D) -> &mut Self

Mutable-borrow form of Self::render_area.

impl<'c, T> PipelineCommand<'c, T>

pub fn bind_pipeline<P>(self, pipeline: P) -> P::Command

where P: Pipeline<'c>,

Equivalent to Command::bind_pipeline for a command that already has a bound pipeline.

pub fn bind_resource<R>(&mut self, resource: R) -> R::Node

where R: Resource,

Equivalent to Command::bind_resource for a command that already has a bound pipeline.

pub fn write_timestamp(&mut self) -> TimestampQuery

Equivalent to Command::write_timestamp for a command that already has a bound pipeline.

pub fn end_cmd(self) -> &'c mut Graph

Equivalent to Command::end_cmd for a command that already has a bound pipeline.

pub fn resource<N>(&self, resource_node: N) -> &N::Resource

where N: Node,

Equivalent to Command::resource for a command that already has a bound pipeline.

pub fn resource_access<N>(self, resource_node: N, access: AccessType) -> Self

where N: Node + Subresource, SubresourceRange: From<N::Range>,

Informs the command that recorded work will read or write resource_node using access.

An access function must be called for resource_node before it is used within a recording function.

pub fn set_resource_access<N>( &mut self, resource_node: N, access: AccessType, ) -> &mut Self

where N: Node + Subresource, SubresourceRange: From<N::Range>,

Mutable-borrow form of Self::resource_access.

pub fn set_shader_resource_access<N>( &mut self, binding: impl Into<Binding>, resource_node: N, access: AccessType, ) -> &mut Self

where N: Node + Subresource, N::Info: Copy, SubresourceRange: From<N::Info>, ViewInfo: From<N::Info>,

Mutable-borrow form of Self::shader_resource_access.

pub fn set_shader_subresource_access<N>( &mut self, binding: impl Into<Binding>, resource_node: N, subresource: impl Into<N::Info>, access: AccessType, ) -> &mut Self

where N: Node + Subresource, N::Info: Copy, SubresourceRange: From<N::Info>, ViewInfo: From<N::Info>,

Mutable-borrow form of Self::shader_subresource_access.

pub fn set_subresource_access<N>( &mut self, resource_node: N, subresource: impl Into<N::Range>, access: AccessType, ) -> &mut Self

where N: Node + Subresource, SubresourceRange: From<N::Range>,

Mutable-borrow form of Self::subresource_access.

pub fn shader_resource_access<N>( self, binding: impl Into<Binding>, resource_node: N, access: AccessType, ) -> Self

where N: Node + Subresource, N::Info: Copy, SubresourceRange: From<N::Info>, ViewInfo: From<N::Info>,

Informs the command that recorded work will read or write the resource_node at the specified shader binding using access.

If the same binding slot is used more than once, the last call wins and the previous binding is silently overwritten.

An access function must be called for resource_node before it is used within a recording function.

pub fn shader_subresource_access<N>( self, binding: impl Into<Binding>, resource_node: N, subresource: impl Into<N::Info>, access: AccessType, ) -> Self

where N: Node + Subresource, N::Info: Copy, SubresourceRange: From<N::Info>, ViewInfo: From<N::Info>,

Informs the command that recorded work will read or write the resource_node at the specified shader binding using access. The resource will be interpreted using view_info.

If the same binding slot is used more than once, the last call wins and the previous binding is silently overwritten.

An access function must be called for resource_node before it is used within a recording function.

pub fn subresource_access<N>( self, resource_node: N, subresource: impl Into<N::Range>, access: AccessType, ) -> Self

where N: Node + Subresource, SubresourceRange: From<N::Range>,

Informs the command that recorded work will read or write the subresource of resource_node using access.

An access function must be called for resource_node before it is used within a recording function.

impl PipelineCommand<'_, RayTracingPipeline>

pub fn record_cmd( self, func: impl FnOnce(RayTracingCommandRef<'_>) + Send + 'static, ) -> Self

Begin recording ray tracing pipeline work for this graph command.

pub fn record_cmd_mut( &mut self, func: impl FnOnce(RayTracingCommandRef<'_>) + Send + 'static, )

Mutable-borrow form of Self::record_cmd.