Struct rendy_chain::Link

pub struct Link<R: Resource> { /* fields omitted */ }

This type defines what states resource are at some point in time when commands recorded into corresponding submissions are executed. Those commands doesn't required to perform actions with all access types declared by the link. But performing actions with access types not declared by the link is prohibited.

Methods

impl<R> Link<R> where
    R: Resource, 

pub fn new(node: LinkNode<R>) -> Self

Create new link with first attached submission.

Parameters

access - Access flags performed in submission. usage - Usage flags required by submission.

pub fn family(&self) -> QueueFamilyId

Get queue family that owns the resource at the link. All associated submissions must be from the same queue family.

pub fn submission_state(&self, sid: SubmissionId) -> State<R>

Get usage.

pub fn state(&self) -> State<R>

Get usage.

pub fn access(&self) -> R::Access

Get access.

pub fn layout(&self) -> R::Layout

Get layout.

pub fn usage(&self) -> R::Usage

Get usage.

pub fn single_queue(&self) -> bool

Check if the link is associated with only one queue.

pub fn compatible(&self, node: &LinkNode<R>) -> bool

Check if the given state and submission are compatible with link. If compatible then the submission can be associated with the link.

pub fn add_node(&mut self, node: LinkNode<R>)

Insert submission with specified state to the link. It must be compatible. Associating submission with the link will allow the submission to be executed in parallel with other submissions associated with this link. Unless other chains disallow.

Panics

This function will panic if state and sid are not compatible. E.g. Link::compatible didn't return true for the arguments.

pub fn queues(&self) -> impl Iterator<Item = (QueueId, &LinkQueueState<R>)>

Iterate over queues.

pub fn queue(&self, qid: QueueId) -> &LinkQueueState<R>

Get particular queue

Trait Implementations

impl<R: Clone + Resource> Clone for Link<R> where
    R::Access: Clone,
    R::Usage: Clone,
    R::Layout: Clone, 

fn clone(&self) -> Link<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug + Resource> Debug for Link<R> where
    R::Access: Debug,
    R::Usage: Debug,
    R::Layout: Debug, 

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

Formats the value using the given formatter.