Skip to main content

LaunchParamsBuilder

Struct LaunchParamsBuilder 

Source
pub struct LaunchParamsBuilder { /* private fields */ }
Expand description

Builder for LaunchParams.

Provides a fluent interface for constructing launch parameters. If grid or block dimensions are not set, they default to Dim3::x(1).

§Examples

use oxicuda_launch::{LaunchParams, Dim3};

let params = LaunchParams::builder()
    .grid((4u32, 4u32))
    .block(256u32)
    .shared_mem(1024)
    .build();

assert_eq!(params.grid, Dim3::xy(4, 4));
assert_eq!(params.block, Dim3::x(256));
assert_eq!(params.shared_mem_bytes, 1024);

Implementations§

Source§

impl LaunchParamsBuilder

Source

pub fn grid(self, dim: impl Into<Dim3>) -> Self

Sets the grid dimensions (number of thread blocks).

Accepts anything that converts to Dim3.

Source

pub fn block(self, dim: impl Into<Dim3>) -> Self

Sets the block dimensions (threads per block).

Accepts anything that converts to Dim3.

Source

pub fn shared_mem(self, bytes: u32) -> Self

Sets the dynamic shared memory allocation in bytes.

Source

pub fn build(self) -> LaunchParams

Builds the LaunchParams.

If grid or block dimensions were not set, they default to Dim3::x(1) (a single block or a single thread).

Trait Implementations§

Source§

impl Debug for LaunchParamsBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LaunchParamsBuilder

Source§

fn default() -> LaunchParamsBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more