GoclImage

GoclImage — Object that represents an image buffer in an OpenCL context

Stability Level

Unstable, unless otherwise indicated

Properties

guint64 depth Read / Write / Construct Only
guint gl-texture Read / Write / Construct Only
guint64 height Read / Write / Construct Only
guint type Read / Write / Construct Only
guint64 width Read / Write / Construct Only

Object Hierarchy

    GObject
    ╰── GoclBuffer
        ╰── GoclImage

Description

A GoclImage represents a image object in an OpenCL context. An image is a special type of buffer that holds pixel information in a convenient way. As buffers, images are also directly accessible from OpenCL programs.

Iamges are created using gocl_image_new() and gocl_image_new_from_gl_texture().

Reading from and writing to images is done using the provided GoclBuffer APIs.

Functions

Property Details

The “depth” property

  “depth”                    guint64

The depth of the image, in pixels.

Owner: GoclImage

Flags: Read / Write / Construct Only

Default value: 0


The “gl-texture” property

  “gl-texture”               guint

The GL texture associated with this image.

Owner: GoclImage

Flags: Read / Write / Construct Only

Default value: 0


The “height” property

  “height”                   guint64

The height of the image, in pixels.

Owner: GoclImage

Flags: Read / Write / Construct Only

Default value: 0


The “type” property

  “type”                     guint

The type of the image (1D, 2D, 3D, etc).

Owner: GoclImage

Flags: Read / Write / Construct Only

Default value: 0


The “width” property

  “width”                    guint64

The width of the image, in pixels.

Owner: GoclImage

Flags: Read / Write / Construct Only

Default value: 0