GoclQueue

GoclQueue — Object that represents an OpenCL command queue

Stability Level

Unstable, unless otherwise indicated

Synopsis

struct              GoclQueue;
struct              GoclQueueClass;
guint               gocl_queue_get_flags                (GoclQueue *self);
cl_command_queue    gocl_queue_get_queue                (GoclQueue *self);

Object Hierarchy

  GObject
   +----GoclQueue

Implemented Interfaces

GoclQueue implements GInitable.

Properties

  "device"                   GoclDevice*           : Read / Write / Construct Only
  "flags"                    guint                 : Read / Write / Construct Only

Description

A GoclQueue represents an OpenCL command queue that is created from a device, using gocl_device_get_default_queue(). Currently, there is no API for creating command queues directly, but that can change as soon as practical use cases require it.

For API simplicity, operations on a command queue are handled elsewhere, like gocl_kernel_run_in_device(), which internally enqueues the execution; or gocl_buffer_read_sync() and gocl_buffer_write_sync(), which internally enqueues read/write operations on the command queue.

Details

struct GoclQueue

struct GoclQueue;

struct GoclQueueClass

struct GoclQueueClass {
  GObjectClass parent_class;
};

The class for GoclQueue objects.

GObjectClass parent_class;

The parent class

gocl_queue_get_flags ()

guint               gocl_queue_get_flags                (GoclQueue *self);

Retrieves the properties of this command queue, as an OR'ed set of values from GoclQueueFlags.

`self` :	The GoclQueue
Returns :	The flags (properties) of the command queue

gocl_queue_get_queue ()

cl_command_queue    gocl_queue_get_queue                (GoclQueue *self);

Retrieves the internal OpenCL cl_command_queue object. This is not normally called by applications. It is rather a low-level, internal API.

`self` :	The GoclQueue
Returns :	The internal cl_command_queue object. [transfer none][type guint64]

Property Details

The `"device"` property

  "device"                   GoclDevice*           : Read / Write / Construct Only

The device this queue belongs to.

The `"flags"` property

  "flags"                    guint                 : Read / Write / Construct Only

The command queue properties.

Allowed values: <= 2

Default value: 0

			Gocl - Documentation and Reference Manual
Top \| Description \| Object Hierarchy \| Implemented Interfaces \| Properties