Struct Pipeline

pub struct Pipeline<C: CubePrimitive> { /* private fields */ }

A mechanism for managing a sequence of memcpy_async For now, it only works at the Cube scope

Implementations

impl<C: CubePrimitive> Pipeline<C>

pub fn new(_num_stages: u8) -> Self

Create a pipeline instance

pub fn memcpy_async( &self, _source: &Slice<Line<C>>, _destination: &mut SliceMut<Line<C>>, )

Copy the source slice to destination

Safety

This will try to copy the whole source slice, so make sure source length <= destination length

pub fn producer_acquire(&self)

Reserves a specific stage for the producer to work on.

pub fn producer_commit(&self)

Signals that the producer is done and the stage is ready for the consumer.

pub fn consumer_wait(&self)

Waits until the producer has finished with the stage.

pub fn consumer_release(&self)

Frees the stage after the consumer is done using it.

pub fn __expand_new(scope: &mut Scope, num_stages: u8) -> PipelineExpand<C>

pub fn __expand_memcpy_async( scope: &mut Scope, expand: PipelineExpand<C>, source: ExpandElementTyped<Slice<Line<C>>>, destination: ExpandElementTyped<SliceMut<Line<C>>>, )

pub fn __expand_producer_acquire(scope: &mut Scope, expand: PipelineExpand<C>)

pub fn __expand_producer_commit(scope: &mut Scope, expand: PipelineExpand<C>)

pub fn __expand_consumer_wait(scope: &mut Scope, expand: PipelineExpand<C>)

pub fn __expand_consumer_release(scope: &mut Scope, expand: PipelineExpand<C>)

Trait Implementations

impl<C: Clone + CubePrimitive> Clone for Pipeline<C>

fn clone(&self) -> Pipeline<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: CubePrimitive> CubeType for Pipeline<C>

type ExpandType = PipelineExpand<C>

fn init(scope: &mut Scope, expand: Self::ExpandType) -> Self::ExpandType

Wrapper around the init method, necessary to type inference.

impl<C: CubePrimitive> Default for Pipeline<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: Copy + CubePrimitive> Copy for Pipeline<C>