Skip to main content

PtxParam

Enum PtxParam 

Source
pub enum PtxParam {
    Scalar {
        name: String,
        ptx_type: PtxType,
    },
    Pointer {
        name: String,
        elem_type: PtxType,
    },
}
Expand description

A parameter to a PTX kernel function.

In PTX, kernel parameters are declared in the .entry signature:

  • Scalar: .param .u32 n — a value passed by copy
  • Pointer: .param .u64 a_ptr — a device memory address (always 64-bit)

For pointer params, elem_type records the type of data pointed to (used by the code generator for load/store instruction types).

Variants§

§

Scalar

A scalar value (e.g. .param .u32 n).

Fields

§name: String

Parameter name.

§ptx_type: PtxType

PTX type of the scalar value.

§

Pointer

A pointer to device memory (declared as .param .u64 name).

Fields

§name: String

Parameter name.

§elem_type: PtxType

Type of the data pointed to (for codegen, not the param declaration).

Implementations§

Source§

impl PtxParam

Source

pub fn scalar(name: &str, ptx_type: PtxType) -> Self

Create a scalar parameter.

Source

pub fn pointer(name: &str, elem_type: PtxType) -> Self

Create a pointer parameter.

Source

pub fn name(&self) -> &str

The parameter name.

Source

pub fn ptx_decl(&self) -> String

PTX parameter declaration string (without trailing comma).

  • Scalar: .param .u32 n
  • Pointer: .param .u64 a_ptr (always 64-bit address)

Trait Implementations§

Source§

impl Clone for PtxParam

Source§

fn clone(&self) -> PtxParam

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PtxParam

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.