# Struct ocl::Queue [−] [src]

    pub struct Queue { /* fields omitted */ }

A command queue which manages all actions taken on kernels, buffers, and images.

## Methods

### `impl Queue`
[src]

#### `pub fn new(
context: &Context,
device: Device,
properties: Option<CommandQueueProperties>
) -> OclResult<Queue>`
[src]

Returns a new Queue on the device specified by `device`.

#### `pub fn flush(&self) -> OclResult<()>`
[src]

Issues all previously queued OpenCL commands to the device.

#### `pub fn finish(&self) -> OclResult<()>`
[src]

Blocks until all commands in this queue have completed before returning.

#### `pub fn enqueue_marker<Ewl>(&self, ewait: Option<Ewl>) -> OclResult<Event> where
Ewl: ClWaitListPtr,`
[src]

Enqueues a marker command which waits for either a list of events to complete, or all previously enqueued commands to complete.

#### `pub fn as_core(&self) -> &CommandQueueCore`
[src]

Returns a reference to the core pointer wrapper, usable by functions in the `core` module.

#### `pub fn context(&self) -> Context`
[src]

Returns a copy of the Context associated with this queue.

#### `pub fn device(&self) -> Device`
[src]

Returns the `OpenCL` device associated with this queue.

#### `pub fn device_version(&self) -> OpenclVersion`
[src]

Returns the cached device version.

#### `pub fn info(
&self,
info_kind: CommandQueueInfo
) -> OclCoreResult<CommandQueueInfoResult>`
[src]

Returns info about this queue.

## Methods from Deref<Target = CommandQueueCore>

#### `pub fn as_ptr(&self) -> *mut c_void`
[src]

Returns a pointer, do not store it.

#### `pub fn device(&self) -> Result<DeviceId, Error>`
[src]

Returns the `DeviceId` associated with this command queue.

#### `pub fn context(&self) -> Result<Context, Error>`
[src]

Returns the `Context` associated with this command queue.

#### `pub fn context_ptr(&self) -> Result<*mut c_void, Error>`
[src]

Returns the `cl_context` associated with this command queue.

## Trait Implementations

### `impl Clone for Queue`
[src]

#### `fn clone(&self) -> Queue`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from `source`. Read more

### `impl Debug for Queue`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl Display for Queue`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl AsRef<Queue> for Queue`
[src]

#### `fn as_ref(&self) -> &Queue`
[src]

Performs the conversion.

### `impl AsRef<CommandQueueCore> for Queue`
[src]

#### `fn as_ref(&self) -> &CommandQueueCore`
[src]

Performs the conversion.

### `impl Deref for Queue`
[src]

#### `type Target = CommandQueueCore`

The resulting type after dereferencing.

#### `fn deref(&self) -> &CommandQueueCore`
[src]

Dereferences the value.

### `impl DerefMut for Queue`
[src]

#### `fn deref_mut(&mut self) -> &mut CommandQueueCore`
[src]

Mutably dereferences the value.

### `impl<'a> ClContextPtr for &'a Queue`
[src]

#### `fn as_ptr(&self) -> cl_context`
[src]

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)