Function

Gimppattern_get_pixels

since: 2.2

Declaration [src]

gboolean
gimp_pattern_get_pixels (
  const gchar* name,
  gint* width,
  gint* height,
  gint* bpp,
  gint* num_color_bytes,
  guint8** color_bytes
)

Description [src]

Retrieve information about the specified pattern (including pixels).

This procedure retrieves information about the specified. This includes the pattern extents (width and height), its bpp and its pixel data.

Available since: 2.2

Parameters

name

Type: const gchar*

The pattern name.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
width

Type: gint*

The pattern width.

The argument will be set by the function.
height

Type: gint*

The pattern height.

The argument will be set by the function.
bpp

Type: gint*

The pattern bpp.

The argument will be set by the function.
num_color_bytes

Type: gint*

Number of pattern bytes.

The argument will be set by the function.
color_bytes

Type: An array of guint8

The pattern data.

The argument will be set by the function.
The length of the array is specified in the num_color_bytes argument.
The called function takes ownership of the data, and is responsible for freeing it.

Return value

Type: gboolean

TRUE on success.