Struct screen_13::graph::pass_ref::PipelinePassRef

pub struct PipelinePassRef<'a, T>where
    T: Access,{ /* private fields */ }

A render pass which has been bound to a particular compute, graphic, or ray-trace pipeline.

Implementations

impl<'a, T> PipelinePassRef<'a, T>where
    T: Access,

pub fn access_descriptor<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    access: AccessType
) -> Selfwhere
    N: Information,
    N: View,
    ViewType: From<<N as View>::Information>,
    <N as View>::Information: From<<N as Information>::Info>,
    <N as View>::Subresource: From<<N as View>::Information>,

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

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

pub fn access_descriptor_as<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    access: AccessType,
    view_info: impl Into<N::Information>
) -> Selfwhere
    N: View,
    <N as View>::Information: Into<ViewType>,
    <N as View>::Subresource: From<<N as View>::Information>,

Informs the pass that the next recorded command buffer will read or write the given node at the specified shader descriptor using access. The node will be interpreted using view_info.

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

pub fn access_descriptor_subrange<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    access: AccessType,
    view_info: impl Into<N::Information>,
    subresource: impl Into<N::Subresource>
) -> Selfwhere
    N: View,
    <N as View>::Information: Into<ViewType>,

Informs the pass that the next recorded command buffer will read or write the subresource of node at the specified shader descriptor using access. The node will be interpreted using view_info.

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

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 PipelinePassRef::read_node or PipelinePassRef::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 PipelinePassRef::read_node_mut or PipelinePassRef::write_node_mut.

pub fn access_node_subrange<N>(
    self,
    node: N,
    access: AccessType,
    subresource: impl Into<N::Subresource>
) -> Selfwhere
    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 PipelinePassRef::read_node_subrange or PipelinePassRef::write_node_subrange.

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 PipelinePassRef::read_node_subrange_mut or PipelinePassRef::write_node_subrange_mut.

pub fn bind_node<'b, B>(
    &'b mut self,
    binding: B
) -> <B as Edge<RenderGraph>>::Resultwhere
    B: Edge<RenderGraph>,
    B: 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 node_info<N>(&self, node: N) -> <N as Information>::Infowhere
    N: Information,

Returns information used to crate a node.

pub fn read_descriptor<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N
) -> Selfwhere
    N: Information,
    N: View,
    ViewType: From<<N as View>::Information>,
    <N as View>::Information: From<<N as Information>::Info>,
    <N as View>::Subresource: From<<N as View>::Information>,

Informs the pass that the next recorded command buffer will read the given node at the specified shader descriptor.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn read_descriptor_as<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    view_info: impl Into<N::Information>
) -> Selfwhere
    N: View,
    <N as View>::Information: Into<ViewType>,
    <N as View>::Subresource: From<<N as View>::Information>,

Informs the pass that the next recorded command buffer will read the given node at the specified shader descriptor. The node will be interpreted using view_info.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn read_descriptor_subrange<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    view_info: impl Into<N::Information>,
    subresource: impl Into<N::Subresource>
) -> Selfwhere
    N: View,
    <N as View>::Information: Into<ViewType>,

Informs the pass that the next recorded command buffer will read the subresource of node at the specified shader descriptor. The node will be interpreted using view_info.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

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

Informs the pass that the next recorded command buffer will read the given node.

The AccessType is inferred by the currently bound pipeline. See Access for details.

This function must be called for node before it is read within a record function. For more specific access, see PipelinePassRef::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.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn read_node_subrange<N>(
    self,
    node: N,
    subresource: impl Into<N::Subresource>
) -> Selfwhere
    N: View,

Informs the pass that the next recorded command buffer will read the subresource of node.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn read_node_subrange_mut<N>(
    &mut self,
    node: N,
    subresource: impl Into<N::Subresource>
)where
    N: View,

Informs the pass that the next recorded command buffer will read the subresource of node.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

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

Finalizes a pass and returns the render graph so that additional passes may be added.

pub fn write_descriptor<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N
) -> Selfwhere
    N: Information,
    N: View,
    <N as View>::Information: Into<ViewType>,
    <N as View>::Information: From<<N as Information>::Info>,
    <N as View>::Subresource: From<<N as View>::Information>,

Informs the pass that the next recorded command buffer will write the given node at the specified shader descriptor.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn write_descriptor_as<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    view_info: impl Into<N::Information>
) -> Selfwhere
    N: View,
    <N as View>::Information: Into<ViewType>,
    <N as View>::Subresource: From<<N as View>::Information>,

Informs the pass that the next recorded command buffer will write the given node at the specified shader descriptor. The node will be interpreted using view_info.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn write_descriptor_subrange<N>(
    self,
    descriptor: impl Into<Descriptor>,
    node: N,
    view_info: impl Into<N::Information>,
    subresource: impl Into<N::Subresource>
) -> Selfwhere
    N: View,
    <N as View>::Information: Into<ViewType>,

Informs the pass that the next recorded command buffer will write the subresource of node at the specified shader descriptor. The node will be interpreted using view_info.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

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

Informs the pass that the next recorded command buffer will write the given node.

The AccessType is inferred by the currently bound pipeline. See Access for details.

This function must be called for node before it is written within a record function. For more specific access, see PipelinePassRef::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.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn write_node_subrange<N>(
    self,
    node: N,
    subresource: impl Into<N::Subresource>
) -> Selfwhere
    N: View,

Informs the pass that the next recorded command buffer will write the subresource of node.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

pub fn write_node_subrange_mut<N>(
    &mut self,
    node: N,
    subresource: impl Into<N::Subresource>
)where
    N: View,

Informs the pass that the next recorded command buffer will write the subresource of node.

The AccessType is inferred by the currently bound pipeline. See Access for details.

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

impl<'a> PipelinePassRef<'a, ComputePipeline>

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

Begin recording a computing command buffer.

impl<'a> PipelinePassRef<'a, GraphicPipeline>

pub fn attach_color(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>
) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_DONT_CARE for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call attach before resolve or store.

pub fn attach_color_as(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_DONT_CARE for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call attach before resolve or store.

pub fn attach_depth_stencil(self, image: impl Into<AnyImageNode>) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_DONT_CARE for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call attach before resolve or store.

pub fn attach_depth_stencil_as(
    self,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_DONT_CARE for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call attach before resolve or store.

pub fn clear_color(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>
) -> Self

Clears the render pass attachment of any existing data.

NOTE: Order matters, call clear before resolve or store.

pub fn clear_color_value(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    color: impl Into<ClearColorValue>
) -> Self

Clears the render pass attachment of any existing data.

NOTE: Order matters, call clear before resolve or store.

pub fn clear_color_value_as(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    color: impl Into<ClearColorValue>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Clears the render pass attachment of any existing data.

NOTE: Order matters, call clear before resolve or store.

pub fn clear_depth_stencil(self, image: impl Into<AnyImageNode>) -> Self

Clears the render pass attachment of any existing data.

NOTE: Order matters, call clear before resolve or store.

pub fn clear_depth_stencil_value(
    self,
    image: impl Into<AnyImageNode>,
    depth: f32,
    stencil: u32
) -> Self

Clears the render pass attachment of any existing data.

NOTE: Order matters, call clear before resolve or store.

pub fn clear_depth_stencil_value_as(
    self,
    image: impl Into<AnyImageNode>,
    depth: f32,
    stencil: u32,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Clears the render pass attachment of any existing data.

NOTE: Order matters, call clear before resolve or store.

pub fn load_color(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>
) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_LOAD for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call load before resolve or store.

pub fn load_color_as(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_LOAD for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call load before resolve or store.

pub fn load_depth_stencil(self, image: impl Into<AnyImageNode>) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_LOAD for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call load before resolve or store.

pub fn load_depth_stencil_as(
    self,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Specifies VK_ATTACHMENT_LOAD_OP_LOAD for the render pass attachment, and loads an image into the framebuffer.

NOTE: Order matters, call load before resolve or store.

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

Begin recording a graphics command buffer.

pub fn resolve_color(
    self,
    src_attachment_idx: AttachmentIndex,
    dst_attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>
) -> Self

Resolves a multisample framebuffer to a non-multisample image for the render pass attachment.

NOTE: Order matters, call resolve after clear or load.

pub fn resolve_color_as(
    self,
    src_attachment_idx: AttachmentIndex,
    dst_attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Resolves a multisample framebuffer to a non-multisample image for the render pass attachment.

NOTE: Order matters, call resolve after clear or load.

pub fn resolve_depth_stencil(
    self,
    dst_attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    depth_mode: Option<ResolveMode>,
    stencil_mode: Option<ResolveMode>
) -> Self

Resolves a multisample framebuffer to a non-multisample image for the render pass attachment.

NOTE: Order matters, call resolve after clear or load.

pub fn resolve_depth_stencil_as(
    self,
    dst_attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>,
    depth_mode: Option<ResolveMode>,
    stencil_mode: Option<ResolveMode>
) -> Self

Resolves a multisample framebuffer to a non-multisample image for the render pass attachment.

NOTE: Order matters, call resolve after clear or load.

pub fn set_depth_stencil(self, depth_stencil: DepthStencilMode) -> Self

Sets a particular depth/stencil mode.

pub fn set_render_area(self, x: i32, y: i32, width: u32, height: u32) -> Self

Sets the [renderArea](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkRenderPassBeginInfo.html#_c_specification) field when beginning a render pass.

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 subpass.

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 set_depth_stencil.

pub fn store_color(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>
) -> Self

Specifies VK_ATTACHMENT_STORE_OP_STORE for the render pass attachment, and stores the rendered pixels into an image.

NOTE: Order matters, call store after clear or load.

pub fn store_color_as(
    self,
    attachment_idx: AttachmentIndex,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Specifies VK_ATTACHMENT_STORE_OP_STORE for the render pass attachment, and stores the rendered pixels into an image.

NOTE: Order matters, call store after clear or load.

pub fn store_depth_stencil(self, image: impl Into<AnyImageNode>) -> Self

Specifies VK_ATTACHMENT_STORE_OP_STORE for the render pass attachment, and stores the rendered pixels into an image.

NOTE: Order matters, call store after clear or load.

pub fn store_depth_stencil_as(
    self,
    image: impl Into<AnyImageNode>,
    image_view_info: impl Into<ImageViewInfo>
) -> Self

Specifies VK_ATTACHMENT_STORE_OP_STORE for the render pass attachment, and stores the rendered pixels into an image.

NOTE: Order matters, call store after clear or load.

impl<'a> PipelinePassRef<'a, RayTracePipeline>

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

Begin recording a ray tracing command buffer.

Trait Implementations

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

fn bind(self, pass: PassRef<'a>) -> PipelinePassRef<'_, 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<'_, 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<'_, RayTracePipeline>

Binds the resource to a graph-like object.