Cogl.Bitmap.map

### Method

# Cogl Bitmapmap

#### Declaration [src]

    uint8_t*
    cogl_bitmap_map (
      CoglBitmap* bitmap,
      CoglBufferAccess access,
      CoglBufferMapHint hints,
      GError** error
    )

#### Description [src]

Maps the bitmap’s underlying data for direct access.

The bitmap will be automatically unmapped when disposed, so explicit unmapping is not required.

#### Parameters

`access`

  Type: `CoglBufferAccess`

  How the mapped buffer will be used by the caller.

`hints`

  Type: `CoglBufferMapHint`

  A mask of `CoglBufferMapHint`s.

`error`

  Type: `GError **`

  The return location for a recoverable error.

  The argument can be `NULL`.
  If the return location is not `NULL`, then you must initialize it to a `NULL` `GError*`.
  The argument will be left initialized to `NULL` by the method if there are no errors.
  In case of error, the argument will be set to a newly allocated `GError`; the caller will take ownership of the data, and be responsible for freeing it.

#### Return value

Type: `uint8_t*`

A pointer to the mapped data or `NULL` if the map failed.

The returned data is owned by the instance.
The return value can be `NULL`.