Struct Module

pub struct Module { /* private fields */ }

Represents a compiled device kernel.

This struct wraps a FFI pointer to the C++ pxl::Module class. It provides methods for creating functions.

Implementations

impl Module

Implementation of the Module struct.

pub fn get(&self) -> *mut Module

Returns a raw pointer to the underlying FFI Module object. This is called in runtime wrapper APIs requiring a raw pointer.

Safety

Caller must ensure that module is valid.

Example

let module_ptr = module.get();

pub fn create_function(&mut self, name: &str) -> Function

Creates a new Function object.

Arguments

• name - Name of the Function to be created.

Returns

A new Function object.

Safety

Caller must ensure that name is valid and corresponds to an actual function in the module.

Example

let module = pxl::create_module("tests/mu_kernel.mubin");
let function = module.create_function("sort_with_ptr");

pub fn destroy_function(&self, function: Function)

Destroys the Function object.

Safety

Caller must ensure that function is valid.

Example

module.destroy_function(function);