UFO_BUFFER_PARAM_SPEC()

#define UFO_BUFFER_PARAM_SPEC(pspec)     (G_TYPE_CHECK_INSTANCE_CAST((pspec), UFO_TYPE_PARAM_BUFFER, UfoBufferParamSpec))

ufo_buffer_new ()

UfoBuffer *
ufo_buffer_new (UfoRequisition *requisition,
                gpointer context);

Create a new UfoBuffer.

ufo_buffer_new_with_size ()

UfoBuffer *
ufo_buffer_new_with_size (GList *dims,
                          gpointer context);

Create a new UfoBuffer with a list of dimensions.

ufo_buffer_new_with_data ()

UfoBuffer *
ufo_buffer_new_with_data (UfoRequisition *requisition,
                          gpointer data,
                          gpointer context);

Create a new buffer using existing host memory.

ufo_buffer_resize ()

void
ufo_buffer_resize (UfoBuffer *buffer,
                   UfoRequisition *requisition);

Resize an existing buffer. If the new requisition has the same size as before, resizing is a no-op.

Since: 0.2

ufo_buffer_cmp_dimensions ()

gint
ufo_buffer_cmp_dimensions (UfoBuffer *buffer,
                           UfoRequisition *requisition);

Compare the size of buffer with a given requisition .

ufo_buffer_get_requisition ()

void
ufo_buffer_get_requisition (UfoBuffer *buffer,
                            UfoRequisition *requisition);

Return the size of buffer .

ufo_buffer_get_size ()

gsize
ufo_buffer_get_size (UfoBuffer *buffer);

Get the number of bytes of raw data that is managed by the buffer .

ufo_buffer_copy ()

void
ufo_buffer_copy (UfoBuffer *src,
                 UfoBuffer *dst);

Copy contents of src to dst . The final memory location is determined by the destination buffer.

ufo_buffer_dup ()

UfoBuffer *
ufo_buffer_dup (UfoBuffer *buffer);

Create a new buffer with the same requisition as buffer . Note, that this is not a copy of buffer !

ufo_buffer_set_host_array ()

void
ufo_buffer_set_host_array (UfoBuffer *buffer,
                           gpointer array,
                           gboolean free_data);

Use this function to set a host array with a user-provided memory buffer. This is useful to expose private data of a generator filter to a subsequent consumer. Note, that the buffer *must* have an appropriate size.

ufo_buffer_copy_host_array ()

void
ufo_buffer_copy_host_array (UfoBuffer *buffer,
                            gpointer array);

Copy data into the buffer.

ufo_buffer_get_host_array ()

gfloat *
ufo_buffer_get_host_array (UfoBuffer *buffer,
                           gpointer cmd_queue);

Returns a flat C-array containing the raw float data.

ufo_buffer_set_device_array ()

void
ufo_buffer_set_device_array (UfoBuffer *buffer,
                             gpointer array,
                             gboolean free_data);

Set the current cl_mem object.

ufo_buffer_get_device_array ()

gpointer
ufo_buffer_get_device_array (UfoBuffer *buffer,
                             gpointer cmd_queue);

Return the current cl_mem object of buffer . If the data is not yet in device memory, it is transfered via cmd_queue to the object. If cmd_queue is NULL cmd_queue , the last used command queue is used.

ufo_buffer_get_device_array_view ()

gpointer
ufo_buffer_get_device_array_view (UfoBuffer *buffer,
                                  gpointer cmd_queue,
                                  UfoRegion *region);

This method creates a new memory buffer that must be freed by the user. Moreover, the original buffer is kept intact.

ufo_buffer_get_device_image ()

gpointer
ufo_buffer_get_device_image (UfoBuffer *buffer,
                             gpointer cmd_queue);

Return the current cl_mem image object of buffer . If the data is not yet in device memory, it is transfered via cmd_queue to the object. If cmd_queue is NULL cmd_queue , the last used command queue is used.

ufo_buffer_get_device_array_with_offset ()

gpointer
ufo_buffer_get_device_array_with_offset
                               (UfoBuffer *buffer,
                                gpointer cmd_queue,
                                gsize offset);

Creates a new cl_mem object with the given offset and a size that is the original size minus the offset.

ufo_buffer_get_location ()

UfoBufferLocation
ufo_buffer_get_location (UfoBuffer *buffer);

Return current location of data backed by buffer .

ufo_buffer_discard_location ()

void
ufo_buffer_discard_location (UfoBuffer *buffer);

Discard the current and use the last location without copying to it first.

ufo_buffer_convert ()

void
ufo_buffer_convert (UfoBuffer *buffer,
                    UfoBufferDepth depth);

Convert host data according to its depth to the internal 32-bit floating point representation.

ufo_buffer_convert_from_data ()

void
ufo_buffer_convert_from_data (UfoBuffer *buffer,
                              gconstpointer data,
                              UfoBufferDepth depth);

Convert data according from depth to the internal 32-bit floating point representation.

Note: data must provide as many bytes as the buffer was initialized with.

ufo_buffer_get_metadata ()

GValue *
ufo_buffer_get_metadata (UfoBuffer *buffer,
                         const gchar *name);

Retrieve meta data.

ufo_buffer_set_metadata ()

void
ufo_buffer_set_metadata (UfoBuffer *buffer,
                         const gchar *name,
                         GValue *value);

Associates a key-value pair with buffer .

ufo_buffer_copy_metadata ()

void
ufo_buffer_copy_metadata (UfoBuffer *src,
                          UfoBuffer *dst);

Copies meta data content from src to dst .

ufo_buffer_get_metadata_keys ()

GList *
ufo_buffer_get_metadata_keys (UfoBuffer *buffer);

Get all meta data keys associated with buffer .

ufo_buffer_max ()

gfloat
ufo_buffer_max (UfoBuffer *buffer,
                gpointer cmd_queue);

Return the maximum value of buffer .

ufo_buffer_min ()

gfloat
ufo_buffer_min (UfoBuffer *buffer,
                gpointer cmd_queue);

Return the minimum value of buffer .

ufo_buffer_param_spec ()

GParamSpec *
ufo_buffer_param_spec (const gchar *name,
                       const gchar *nick,
                       const gchar *blurb,
                       UfoBuffer *default_value,
                       GParamFlags flags);

Creates a new UfoBufferParamSpec instance specifying a UFO_TYPE_BUFFER property.

struct UfoBuffer

struct UfoBuffer;

Represents n-dimensional data. The contents of the UfoBuffer structure are private and should only be accessed via the provided API.

UFO_BUFFER_MAX_NDIMS

#define UFO_BUFFER_MAX_NDIMS 3

Maximum number of allowed dimensions. This is a pre-processor macro instead of const variable because of C constraints.

struct UfoBufferClass

struct UfoBufferClass {
};

UfoBuffer class

struct UfoBufferParamSpec

struct UfoBufferParamSpec {
};

UfoBufferParamSpec class

struct UfoRequisition

struct UfoRequisition {
    guint n_dims;
    gsize dims[UFO_BUFFER_MAX_NDIMS];
};

Used to specify buffer size requirements.

struct UfoRegion

struct UfoRegion {
    gsize origin[UFO_BUFFER_MAX_NDIMS];
    gsize size[UFO_BUFFER_MAX_NDIMS];
};

Defines a region with at most UFO_BUFFER_MAX_NDIMS dimensions for use with ufo_buffer_get_device_array_view().

enum UfoBufferDepth

Source depth of data as used in ufo_buffer_convert().

enum UfoBufferLocation

Location of the backed data memory.