Struct 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) -> >::Result
where B: Edge<Self> + 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>, filter: Filter, region: ImageBlit, ) -> &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>, filter: Filter, regions: impl AsRef<[ImageBlit]> + 'static + Send, ) -> &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 AsRef<[BufferCopy]> + 'static + Send, ) -> &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 AsRef<[BufferImageCopy]> + 'static + Send, ) -> &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 AsRef<[ImageCopy]> + 'static + Send, ) -> &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 AsRef<[BufferImageCopy]> + 'static + Send, ) -> &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_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.

Source

pub fn node_info<N>(&self, node: N) -> <N as Information>::Info
where 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>>::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.

Source

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.

Source

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§

Source §