struct GoclContext

struct GoclContext;

struct GoclContextClass

struct GoclContextClass {
  GObjectClass parent_class;
};

The class for GoclContext objects.

gocl_context_new_sync ()

GoclContext *       gocl_context_new_sync               (GoclDeviceType device_type);

Attempts to create a GoclContext of the type specified in device_type. Upon error, NULL is returned. On success, a new GoclContext object is returned.

gocl_context_gpu_new_sync ()

GoclContext *       gocl_context_gpu_new_sync           (gpointer gl_context,
                                                         gpointer gl_display);

Attemps to create a new GPU context. If gl_context and gl_display are provided (not NULL), then the context will be setup to share objects with an existing OpenGL context. For this to work, the <i>cl_khr_gl_sharing</i> extension should be supported by the OpenCL GPU implementation.

gocl_context_get_default_cpu_sync ()

GoclContext *       gocl_context_get_default_cpu_sync   (void);

Returns platform's default CPU context. The first call to this method will attempt to create a new GoclContext using a device type of GOCL_DEVICE_TYPE_CPU. Upon success, the context is cached and subsequent calls will return the same object, increasing its reference count.

gocl_context_get_default_gpu_sync ()

GoclContext *       gocl_context_get_default_gpu_sync   (void);

Returns platform's default GPU context. The first call to this method will attempt to create a new GoclContext using a device type of GOCL_DEVICE_TYPE_GPU. Upon success, the context is cached and subsequent calls will return the same object, increasing its reference count.

gocl_context_get_context ()

cl_context          gocl_context_get_context            (GoclContext *self);

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

gocl_context_get_num_devices ()

guint               gocl_context_get_num_devices        (GoclContext *self);

Obtains the number of devices in this context. Calls to gocl_context_get_device_by_index() must provide a device index between 0 and the number of devices returned by this method, minus one.

gocl_context_get_device_by_index ()

GoclDevice *        gocl_context_get_device_by_index    (GoclContext *self,
                                                         guint device_index);

Retrieves the device_index-th device from the list of context devices. Use gocl_context_get_num_devices() to get the number of devices in the context.

Notice that method creates a new GoclDevice instance every time is called.

gocl_device_get_context ()

GoclContext *       gocl_device_get_context             (GoclDevice *device);

Obtains the GoclContext the device belongs to.

gocl_buffer_new ()

GoclBuffer *        gocl_buffer_new                     (GoclContext *context,
                                                         guint flags,
                                                         gsize size,
                                                         gpointer host_ptr);

Creates a new buffer on context's memory. Depending on flags, the host_ptr pointer can be used to initialize the contents of the buffer from a block of memory in the host.

gocl_buffer_get_context ()

GoclContext *       gocl_buffer_get_context             (GoclBuffer *buffer);

Retrieves the GoclContext the buffer belongs to.

gocl_image_new ()

GoclImage *         gocl_image_new                      (GoclContext *context,
                                                         guint flags,
                                                         gpointer host_ptr,
                                                         GoclImageType type,
                                                         gsize width,
                                                         gsize height,
                                                         gsize depth);

Creates a new image buffer. Currently only 8-bits unsigned integer format is supported, with RGBA channels. Other image properties like row pitch, slice pitch, etc. are assumed to be zero by now.

gocl_image_new_from_gl_texture ()

GoclImage *         gocl_image_new_from_gl_texture      (GoclContext *context,
                                                         guint flags,
                                                         guint texture);

Creates a new image buffer from a GL texture handle. This only works if the OpenCL platform supports the <i>cl_khr_gl_sharing</i> extension, and the context has been created for sharing with OpenGL, using gocl_context_gpu_new_sync().

gocl_image_new_from_cogl_texture ()

GoclImage *         gocl_image_new_from_cogl_texture    (GoclContext *context,
                                                         guint flags,
                                                         CoglTexture *texture);

Creates a new image buffer from a CoglTexture object. This only works if the OpenCL platform supports the <i>cl_khr_gl_sharing</i> extension, and the context has been created for sharing with OpenGL, using gocl_context_gpu_new_sync().

The "device-type" property

  "device-type"              guint                 : Read / Write / Construct Only

The device type for this context.

Allowed values: >= 1

Default value: 1

The "gl-context" property

  "gl-context"               gpointer              : Read / Write / Construct Only

The GL context for data sharing.

The "gl-display" property

  "gl-display"               gpointer              : Read / Write / Construct Only

The GL display for data sharing.