Struct TaskGraph

pub struct TaskGraph<W: ?Sized> { /* private fields */ }

The task graph is a directed acyclic graph consisting of Task nodes, with edges representing happens-before relations.

Implementations

impl<W: ?Sized> TaskGraph<W>

pub unsafe fn compile( self, compile_info: &CompileInfo<'_>, ) -> Result<ExecutableTaskGraph<W>, CompileError<W>>

Compiles the task graph into an executable form.

Safety

• There must be no conflicting device accesses in task nodes with no path between them.
• There must be no accesses that are incompatible with the queue family type of the task node.
• There must be no accesses that are unsupported by the device.

Panics

• Panics if compile_info.queues is empty.
• Panics if the device of any queue in compile_info.queues or compile_info.present_queue is not the same as that of self.
• Panics if compile_info.queues contains duplicate queue families.
• Panics if compile_info.present_queue is None and the task graph uses any swapchains.

Errors

In order to get a successful compilation, the graph must satisfy the following conditions:

• It must be weakly connected: every node must be able to reach every other node when disregarding the direction of the edges.
• It must have no directed cycles: if you were to walk starting from any node following the direction of the edges, there must be no way to end up at the node you started at.

impl<W: ?Sized> TaskGraph<W>

pub fn new( physical_resources: &Arc<Resources>, max_nodes: u32, max_resources: u32, ) -> Self

Creates a new TaskGraph.

max_nodes is the maximum number of nodes the graph can ever have. max_resources is the maximum number of virtual resources the graph can ever have.

pub fn create_task_node( &mut self, name: impl Into<Cow<'static, str>>, queue_family_type: QueueFamilyType, task: impl Task<World = W>, ) -> TaskNodeBuilder<'_>

Creates a new TaskNode from the given task and adds it to the graph. Returns a builder allowing you to add resource accesses to the task node.

queue_family_type is the type of queue family the task can be executed on.

pub fn remove_task_node( &mut self, id: NodeId, ) -> Result<TaskNode<W>, TaskGraphError>

Removes the task node corresponding to id from the graph.

pub fn add_edge( &mut self, from: NodeId, to: NodeId, ) -> Result<(), TaskGraphError>

Adds an edge starting at the node corresponding to from and ending at the node corresponding to to.

pub fn remove_edge( &mut self, from: NodeId, to: NodeId, ) -> Result<(), TaskGraphError>

Removes an edge starting at the node corresponding to from and ending at the node corresponding to to.

pub fn task_node(&self, id: NodeId) -> Result<&TaskNode<W>, TaskGraphError>

Returns a reference to the task node corresponding to id.

pub fn task_node_mut( &mut self, id: NodeId, ) -> Result<&mut TaskNode<W>, TaskGraphError>

Returns a mutable reference to the task node corresponding to id.

pub fn task_nodes(&self) -> TaskNodes<'_, W>

Returns an iterator over all TaskNodes.

pub fn task_nodes_mut(&mut self) -> TaskNodesMut<'_, W>

Returns an iterator over all TaskNodes that allows you to mutate them.

pub fn add_buffer(&mut self, create_info: &BufferCreateInfo) -> Id<Buffer>

Add a [virtual buffer resource] to the task graph.

pub fn add_image(&mut self, create_info: &ImageCreateInfo) -> Id<Image>

Add a [virtual image resource] to the task graph.

pub fn add_swapchain( &mut self, create_info: &SwapchainCreateInfo, ) -> Id<Swapchain>

Add a [virtual swapchain resource] to the task graph.

pub fn add_host_buffer_access( &mut self, id: Id<Buffer>, access_type: HostAccessType, )

Adds a host buffer access to the task graph.

Panics

• Panics if id is not a valid virtual resource ID nor a valid physical ID.

pub fn add_framebuffer(&mut self) -> Id<Framebuffer>

Adds a [virtual framebuffer] to the task graph.

Trait Implementations

impl<W: ?Sized> Debug for TaskGraph<W>

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

Formats the value using the given formatter.

impl<W: ?Sized> DeviceOwned for TaskGraph<W>

fn device(&self) -> &Arc<Device>

Returns the device that owns self.