Struct ocl::ContextBuilder [−] [src]

pub struct ContextBuilder {
    // some fields omitted
}

A builder for Context.

Currently ignores all of the cl_context_properties except for platform. Use Context::new directly to specify ContextProperties in all its glory. [UPDATE ME]

[WORK IN PROGRESS]

TODO: Implement index-searching-round-robin-ing methods (and thier '_exact' counterparts).

Methods

impl ContextBuilder
[src]

fn new() -> ContextBuilder

Creates a new ContextBuilder

Use Context::builder().build().unwrap() for defaults.

Defaults

  • The first avaliable platform
  • All devices associated with the first available platform
  • No notify callback function or user data.

TODO: That stuff above (find a valid context, devices, etc. first thing).

fn build(&self) -> OclResult<Context>

Returns a new Context with the parameters hitherinforthto specified (say what?).

fn platform<'a>(&'a mut self, platform: Platform) -> &'a mut ContextBuilder

Specifies a platform.

Panics

Panics if it has already been specified.

fn properties<'a>(&'a mut self, properties: ContextProperties) -> &'a mut ContextBuilder

Specify context properties directly.

Panics

Panics if properties have already been specified.

fn device_list<'a>(&'a mut self, devices: Vec<Device>) -> &'a mut ContextBuilder

Specifies a list of devices.

Panics

Panics if any devices have already been specified.

fn devices<'a>(&'a mut self, device_spec: DeviceSpecifier) -> &'a mut ContextBuilder

Specifies a DeviceSpecifer which specifies how specifically the relevant devices shall be specified.

See DeviceSpecifier for actually useful documentation.

Panics

Panics if any devices have already been specified.