Struct screen_13::graph::RenderGraph

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

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

impl RenderGraph

pub fn new() -> Self

Constructs a new RenderGraph.

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

Begins a new pass.

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

where B: Edge<Self> + Bind<&'a mut Self, <B as Edge<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.

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.

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

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

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

Copy regions of an image, potentially performing format conversion.

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

Clear a color image.

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

Clear a color image.

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

Clears a depth/stencil image.

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.

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

Copy data between buffers

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.

pub fn copy_buffer_regions( &mut self, src_node: impl Into<AnyBufferNode>, dst_node: impl Into<AnyBufferNode>, regions: impl AsRef<[BufferCopy]> + 'static + Send ) -> &mut Self

Copy data between buffer regions.

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.

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.

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

Copy data from a buffer into an image.

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

Copy data between images.

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.

pub fn copy_image_regions( &mut self, src_node: impl Into<AnyImageNode>, dst_node: impl Into<AnyImageNode>, regions: impl AsRef<[ImageCopy]> + 'static + Send ) -> &mut Self

Copy data between images.

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.

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.

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

Copy image data into a buffer.

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.

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.

pub fn node_device_address( &self, node: impl Into<AnyBufferNode> ) -> DeviceAddress

Returns the device address of a buffer node.

Panics

Panics if the buffer is not currently bound or was not created with the SHADER_DEVICE_ADDRESS usage flag.

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

where N: Information,

Returns information used to crate a node.

pub fn resolve(self) -> Resolver

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

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

where N: Edge<Self> + Unbind<Self, <N as Edge<Self>>::Result>,

Removes a node from this graph.

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

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

Note: data must not exceed 65536 bytes.

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

Note: data must not exceed 65536 bytes.

Trait Implementations

impl<'a> Bind<&mut RenderGraph, AccelerationStructureLeaseNode> for &'a Arc<Lease<AccelerationStructure>>

fn bind(self, graph: &mut RenderGraph) -> AccelerationStructureLeaseNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, AccelerationStructureLeaseNode> for Arc<Lease<AccelerationStructure>>

fn bind(self, graph: &mut RenderGraph) -> AccelerationStructureLeaseNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, AccelerationStructureLeaseNode> for Lease<AccelerationStructure>

fn bind(self, graph: &mut RenderGraph) -> AccelerationStructureLeaseNode

Binds the resource to a graph-like object.

impl<'a> Bind<&mut RenderGraph, AccelerationStructureNode> for &'a Arc<AccelerationStructure>

fn bind(self, graph: &mut RenderGraph) -> AccelerationStructureNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, AccelerationStructureNode> for AccelerationStructure

fn bind(self, graph: &mut RenderGraph) -> AccelerationStructureNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, AccelerationStructureNode> for Arc<AccelerationStructure>

fn bind(self, graph: &mut RenderGraph) -> AccelerationStructureNode

Binds the resource to a graph-like object.

impl<'a> Bind<&mut RenderGraph, BufferLeaseNode> for &'a Arc<Lease<Buffer>>

fn bind(self, graph: &mut RenderGraph) -> BufferLeaseNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, BufferLeaseNode> for Arc<Lease<Buffer>>

fn bind(self, graph: &mut RenderGraph) -> BufferLeaseNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, BufferLeaseNode> for Lease<Buffer>

fn bind(self, graph: &mut RenderGraph) -> BufferLeaseNode

Binds the resource to a graph-like object.

impl<'a> Bind<&mut RenderGraph, BufferNode> for &'a Arc<Buffer>

fn bind(self, graph: &mut RenderGraph) -> BufferNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, BufferNode> for Arc<Buffer>

fn bind(self, graph: &mut RenderGraph) -> BufferNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, BufferNode> for Buffer

fn bind(self, graph: &mut RenderGraph) -> BufferNode

Binds the resource to a graph-like object.

impl<'a> Bind<&mut RenderGraph, ImageLeaseNode> for &'a Arc<Lease<Image>>

fn bind(self, graph: &mut RenderGraph) -> ImageLeaseNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, ImageLeaseNode> for Arc<Lease<Image>>

fn bind(self, graph: &mut RenderGraph) -> ImageLeaseNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, ImageLeaseNode> for Lease<Image>

fn bind(self, graph: &mut RenderGraph) -> ImageLeaseNode

Binds the resource to a graph-like object.

impl<'a> Bind<&mut RenderGraph, ImageNode> for &'a Arc<Image>

fn bind(self, graph: &mut RenderGraph) -> ImageNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, ImageNode> for Arc<Image>

fn bind(self, graph: &mut RenderGraph) -> ImageNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, ImageNode> for Image

fn bind(self, graph: &mut RenderGraph) -> ImageNode

Binds the resource to a graph-like object.

impl Bind<&mut RenderGraph, SwapchainImageNode> for SwapchainImage

fn bind(self, graph: &mut RenderGraph) -> SwapchainImageNode

Binds the resource to a graph-like object.

impl Debug for RenderGraph

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Unbind<RenderGraph, Arc<AccelerationStructure>> for AccelerationStructureNode

fn unbind(self, graph: &mut RenderGraph) -> Arc<AccelerationStructure>

Unbinds the resource from a graph-like object.

impl Unbind<RenderGraph, Arc<Buffer>> for BufferNode

fn unbind(self, graph: &mut RenderGraph) -> Arc<Buffer>

Unbinds the resource from a graph-like object.

impl Unbind<RenderGraph, Arc<Image>> for ImageNode

fn unbind(self, graph: &mut RenderGraph) -> Arc<Image>

Unbinds the resource from a graph-like object.

impl Unbind<RenderGraph, Arc<Lease<AccelerationStructure>>> for AccelerationStructureLeaseNode

fn unbind(self, graph: &mut RenderGraph) -> Arc<Lease<AccelerationStructure>>

Unbinds the resource from a graph-like object.

impl Unbind<RenderGraph, Arc<Lease<Buffer>>> for BufferLeaseNode

fn unbind(self, graph: &mut RenderGraph) -> Arc<Lease<Buffer>>

Unbinds the resource from a graph-like object.

impl Unbind<RenderGraph, Arc<Lease<Image>>> for ImageLeaseNode

fn unbind(self, graph: &mut RenderGraph) -> Arc<Lease<Image>>

Unbinds the resource from a graph-like object.