Struct PassRef

pub struct PassRef<'a> { /* private fields */ }

A general render pass which may contain acceleration structure commands, general commands, or have pipeline bound to then record commands specific to those pipeline types.

Implementations

impl<'a> PassRef<'a>

pub fn access_node( self, node: impl Node + Information, access: AccessType, ) -> Self

Informs the pass that the next recorded command buffer will read or write the given node using access.

This function must be called for node before it is read or written within a record function. For general purpose access, see PassRef::read_node or PassRef::write_node.

pub fn access_node_mut( &mut self, node: impl Node + Information, access: AccessType, )

Informs the pass that the next recorded command buffer will read or write the given node using access.

This function must be called for node before it is read or written within a record function. For general purpose access, see PassRef::read_node_mut or PassRef::write_node_mut.

pub fn access_node_subrange<N>( self, node: N, access: AccessType, subresource: impl Into<N::Subresource>, ) -> Self

where N: View,

Informs the pass that the next recorded command buffer will read or write the subresource of node using access.

This function must be called for node before it is read or written within a record function. For general purpose access, see PassRef::read_node or PassRef::write_node.

pub fn access_node_subrange_mut<N>( &mut self, node: N, access: AccessType, subresource: impl Into<N::Subresource>, )

where N: View,

Informs the pass that the next recorded command buffer will read or write the subresource of node using access.

This function must be called for node before it is read or written within a record function. For general purpose access, see PassRef::read_node or PassRef::write_node.

pub fn bind_node<'b, B>( &'b mut self, binding: B, ) -> <B as Edge<RenderGraph>>::Result

where B: Edge<RenderGraph> + Bind<&'b mut RenderGraph, <B as Edge<RenderGraph>>::Result>,

Binds a Vulkan acceleration structure, buffer, or image to the graph associated with this pass.

Bound nodes may be used in passes for pipeline and shader operations.

pub fn bind_pipeline<B>(self, binding: B) -> <B as Edge<Self>>::Result

where B: Edge<Self> + Bind<Self, <B as Edge<Self>>::Result>,

Binds a ComputePipeline, GraphicPipeline, or RayTracePipeline to the current pass, allowing for strongly typed access to the related functions.

pub fn node_info<N>(&self, node: N) -> <N as Information>::Info

where N: Information,

Returns information used to crate a node.

pub fn read_node(self, node: impl Node + Information) -> Self

Informs the pass that the next recorded command buffer will read the given node using AccessType::AnyShaderReadSampledImageOrUniformTexelBuffer.

This function must be called for node before it is read within a record function. For more specific access, see PassRef::access_node.

pub fn read_node_mut(&mut self, node: impl Node + Information)

Informs the pass that the next recorded command buffer will read the given node using AccessType::AnyShaderReadSampledImageOrUniformTexelBuffer.

This function must be called for node before it is read within a record function. For more specific access, see PassRef::access_node.

pub fn record_acceleration( self, func: impl FnOnce(Acceleration<'_>, Bindings<'_>) + Send + 'static, ) -> Self

Begin recording an acceleration structure command buffer.

This is the entry point for building and updating an AccelerationStructure instance.

pub fn record_cmd_buf( self, func: impl FnOnce(&Device, CommandBuffer, Bindings<'_>) + Send + 'static, ) -> Self

Begin recording a general command buffer.

The provided closure allows you to run any Vulkan code, or interoperate with other Vulkan code and interfaces.

pub fn submit_pass(self) -> &'a mut RenderGraph

Finalize the recording of this pass and return to the RenderGraph where you may record additional passes.

pub fn write_node(self, node: impl Node + Information) -> Self

Informs the pass that the next recorded command buffer will write the given node using AccessType::AnyShaderWrite.

This function must be called for node before it is written within a record function. For more specific access, see PassRef::access_node.

pub fn write_node_mut(&mut self, node: impl Node + Information)

Informs the pass that the next recorded command buffer will write the given node using AccessType::AnyShaderWrite.

This function must be called for node before it is written within a record function. For more specific access, see PassRef::access_node.

Trait Implementations

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, ComputePipeline>> for &'a Arc<ComputePipeline>

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, ComputePipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, ComputePipeline>> for Arc<ComputePipeline>

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, ComputePipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, ComputePipeline>> for ComputePipeline

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, ComputePipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, GraphicPipeline>> for &'a Arc<GraphicPipeline>

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, GraphicPipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, GraphicPipeline>> for Arc<GraphicPipeline>

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, GraphicPipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, GraphicPipeline>> for GraphicPipeline

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, GraphicPipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, RayTracePipeline>> for &'a Arc<RayTracePipeline>

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, RayTracePipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, RayTracePipeline>> for Arc<RayTracePipeline>

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, RayTracePipeline>

Binds the resource to a graph-like object.

impl<'a> Bind<PassRef<'a>, PipelinePassRef<'a, RayTracePipeline>> for RayTracePipeline

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'a, RayTracePipeline>

Binds the resource to a graph-like object.