Struct blaze_rs::context::Global

pub struct Global;

Global Context

Inspired by Rust’s Allocator syntax, Global is a ZST that will be treated as the default context for most operations requiring of an OpenCL context or command queue.

Like with the Allocator API, you can specify a global context with the #[global_context] macro.

use blaze_rs::prelude::*;

#[global_context]
static CONTEXT : SimpleContext = SimpleContext::default();

#[test]
fn with_global () -> Result<()> {
    // Initialize two buffers
    let buffer : Buffer<i32> = Buffer::new(&[1, 2, 3, 4, 5], MemAccess::READ_ONLY, false)?;
    let buffer2 : Buffer<i32> = Buffer::new(&[5, 4, 3, 2, 1], MemAccess::WRITE_ONLY, false)?;

    // Read the full contents of both buffers
    let read = buffer.read_blocking(.., None)?;
    let read2 = buffer2.read_blocking(.., Some(core::slice::from_ref(&read)))?;

    assert_eq!(read.as_slice(), &[5, 4, 3, 2, 1]);
    assert_eq!(read2.as_slice(), &[1, 2, 3, 4, 5]);
    Ok(())
}

#[test]
fn without_global () -> Result<()> {
    // Initialize a context.
    let ctx = SimpleContext::default()?;
    
    // Initialize two buffers
    let buffer : Buffer<i32, &SimpleContext> = Buffer::new_in(&ctx, &[1, 2, 3, 4, 5], MemAccess::READ_ONLY, false)?;
    let buffer2 : Buffer<i32, &SimpleContext> = Buffer::new_in(&ctx, &[5, 4, 3, 2, 1], MemAccess::WRITE_ONLY, false)?;

    // Read the full contents of both buffers
    let read = buffer.read_blocking(.., None)?;
    let read2 = buffer2.read_blocking(.., Some(core::slice::from_ref(&read)))?;

    assert_eq!(read.as_slice(), &[5, 4, 3, 2, 1]);
    assert_eq!(read2.as_slice(), &[1, 2, 3, 4, 5]);
    Ok(())
}

Note that unlike with the Allocator API, no default global context is set, so you’ll need to specify one explicitly if you want to use it.

Implementations

impl Global

pub fn get() -> &'static Global

Returns a reference to a static global allocator. This is a convenience function for when needing to pass a reference to a Context.

Methods from Deref<Target = RawContext>

pub fn id(&self) -> cl_context

pub unsafe fn retain(&self) -> Result<()>

pub fn reference_count(&self) -> Result<u32>

Return the context reference count.

pub fn num_devices(&self) -> Result<u32>

Return the number of devices in context.

pub fn devices(&self) -> Result<Vec<RawDevice>>

Return the list of devices and sub-devices in context.

pub fn greatest_common_version(&self) -> Result<Version>

Returns the greatest common OpenCL version of this context’s devices.

pub fn properties(&self) -> Result<ContextProperties>

Return the properties argument specified in creation

pub fn on_destruct(&self, f: impl 'static + FnOnce() + Send) -> Result<()>

Available on crate feature cl3 only.

pub unsafe fn on_destruct_raw( &self, f: unsafe extern "C" fn(context: cl_context, user_data: *mut c_void), user_data: *mut c_void ) -> Result<()>

Available on crate feature cl3 only.

Trait Implementations

impl Clone for Global

fn clone(&self) -> Global

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Context for Global

fn next_queue(&self) -> &CommandQueue

Returns the next CommandQueue, as per context implementation

fn as_raw(&self) -> &RawContext

Returns a reference to the underlying RawContext

fn queues(&self) -> &[CommandQueue]

Returns a slice with all of the Context’s command queues

fn flush_all(&self) -> Result<()>

Flushes all the CommandQueues in the context.

fn finish_all(&self) -> Result<()>

Finishes all the CommandQueues in the context.

impl Debug for Global

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

Formats the value using the given formatter.

impl Default for Global

fn default() -> Global

Returns the “default value” for a type.

impl Deref for Global

type Target = RawContext

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Copy for Global