Struct screen_13::graph::RenderGraph

source · [−]

pub struct RenderGraph {
    pub debug: bool,
    /* private fields */
}

Expand description

A composable graph of render pass operations.

RenderGraph instances are are intended for one-time use.

The design of this code originated with a combination of PassBuilder and render_graph.cpp.

Fields

debug: bool

Set to true (when in debug mode) in order to get a breakpoint hit where you want.

Implementations

source

impl RenderGraph

source

pub fn new() -> Self

Constructs a new RenderGraph.

source

pub fn begin_pass(&mut self, name: impl AsRef<str>) -> PassRef<'_>

Begins a new pass.

source

pub fn bind_node<'a, B>(&'a mut self, binding: B) -> >::Resultwhere
B: Edge<Self>,
B: Bind<&'a mut Self, >::Result>,

Binds a Vulkan acceleration structure, buffer, or image to this graph.

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

source

pub fn blit_image(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyImageNode>,
 filter: Filter
) -> &mut Self

Copy an image, potentially performing format conversion.

source

pub fn blit_image_region(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyImageNode>,
 region: &ImageBlit,
 filter: Filter
) -> &mut Self

Copy a region of an image, potentially performing format conversion.

source

pub fn blit_image_regions(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyImageNode>,
 regions: impl Into<Box<[ImageBlit]>>,
 filter: Filter
) -> &mut Self

Copy regions of an image, potentially performing format conversion.

source

pub fn clear_color_image(
&mut self,
image_node: impl Into<AnyImageNode>
) -> &mut Self

Clear a color image.

source

pub fn clear_color_image_value(
 &mut self,
 image_node: impl Into<AnyImageNode>,
 color_value: impl Into<ClearColorValue>
) -> &mut Self

Clear a color image.

source

pub fn clear_depth_stencil_image(
&mut self,
image_node: impl Into<AnyImageNode>
) -> &mut Self

Clears a depth/stencil image.

source

pub fn clear_depth_stencil_image_value(
 &mut self,
 image_node: impl Into<AnyImageNode>,
 depth: f32,
 stencil: u32
) -> &mut Self

Clears a depth/stencil image.

source

pub fn copy_buffer(
 &mut self,
 src_node: impl Into<AnyBufferNode>,
 dst_node: impl Into<AnyBufferNode>
) -> &mut Self

Copy data between buffers

source

pub fn copy_buffer_region(
 &mut self,
 src_node: impl Into<AnyBufferNode>,
 dst_node: impl Into<AnyBufferNode>,
 region: &BufferCopy
) -> &mut Self

Copy data between buffer regions.

source

pub fn copy_buffer_regions(
 &mut self,
 src_node: impl Into<AnyBufferNode>,
 dst_node: impl Into<AnyBufferNode>,
 regions: impl Into<Box<[BufferCopy]>>
) -> &mut Self

Copy data between buffer regions.

source

pub fn copy_buffer_to_image(
 &mut self,
 src_node: impl Into<AnyBufferNode>,
 dst_node: impl Into<AnyImageNode>
) -> &mut Self

Copy data from a buffer into an image.

source

pub fn copy_buffer_to_image_region(
 &mut self,
 src_node: impl Into<AnyBufferNode>,
 dst_node: impl Into<AnyImageNode>,
 region: &BufferImageCopy
) -> &mut Self

Copy data from a buffer into an image.

source

pub fn copy_buffer_to_image_regions(
 &mut self,
 src_node: impl Into<AnyBufferNode>,
 dst_node: impl Into<AnyImageNode>,
 regions: impl Into<Box<[BufferImageCopy]>>
) -> &mut Self

Copy data from a buffer into an image.

source

pub fn copy_image(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyImageNode>
) -> &mut Self

Copy data between images.

source

pub fn copy_image_region(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyImageNode>,
 region: &ImageCopy
) -> &mut Self

Copy data between images.

source

pub fn copy_image_regions(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyImageNode>,
 regions: impl Into<Box<[ImageCopy]>>
) -> &mut Self

Copy data between images.

source

pub fn copy_image_to_buffer(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyBufferNode>
) -> &mut Self

Copy image data into a buffer.

source

pub fn copy_image_to_buffer_region(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyBufferNode>,
 region: &BufferImageCopy
) -> &mut Self

Copy image data into a buffer.

source

pub fn copy_image_to_buffer_regions(
 &mut self,
 src_node: impl Into<AnyImageNode>,
 dst_node: impl Into<AnyBufferNode>,
 regions: impl Into<Box<[BufferImageCopy]>>
) -> &mut Self

Copy image data into a buffer.

source

pub fn fill_buffer(
 &mut self,
 buffer_node: impl Into<AnyBufferNode>,
 data: u32
) -> &mut Self

Fill a region of a buffer with a fixed value.

source

pub fn fill_buffer_region(
 &mut self,
 buffer_node: impl Into<AnyBufferNode>,
 data: u32,
 region: Range<DeviceSize>
) -> &mut Self

Fill a region of a buffer with a fixed value.

source

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

Returns information used to crate a node.

source

pub fn resolve(self) -> Resolver

Finalizes the graph and provides an object with functions for submitting the resulting commands.

source

pub fn unbind_node<N>(&mut self, node: N) -> <N as Edge<Self>>::Resultwhere
N: Edge<Self>,
N: Unbind<Self, <N as Edge<Self>>::Result>,

Removes a node from this graph.

Future access to node on this graph will return invalid results.

source

pub fn update_buffer(
 &mut self,
 buffer_node: impl Into<AnyBufferNode>,
 data: &'static [u8]
) -> &mut Self

Note: data must not exceed 65536 bytes.

source

pub fn update_buffer_offset(
 &mut self,
 buffer_node: impl Into<AnyBufferNode>,
 data: &'static [u8],
 offset: DeviceSize
) -> &mut Self

Note: data must not exceed 65536 bytes.

Trait Implementations

source