Allow propogation of OOM errors to apps

This allows apps to catch out-of-memory errors when allocating textures.

Textures can be pretty huge at times and so it's quite possible for an
application to try and allocate more memory than is available. It's also
very possible that the application can take some action in response to
reduce memory pressure (such as freeing up texture caches perhaps) so
we shouldn't just automatically abort like we do for trivial heap
allocations.

These public functions now take a CoglError argument so applications can
catch out of memory errors:

cogl_buffer_map
cogl_buffer_map_range
cogl_buffer_set_data
cogl_framebuffer_read_pixels_into_bitmap
cogl_pixel_buffer_new
cogl_texture_new_from_data
cogl_texture_new_from_bitmap

Note: we've been quite conservative with how many apis we let throw OOM
CoglErrors since we don't really want to put a burdon on developers to
be checking for errors with every cogl api call. So long as there is
some lower level api for apps to use that let them catch OOM errors
for everything necessary that's enough and we don't have to make more
convenient apis more awkward to use.

The main focus is on bitmaps and texture allocations since they
can be particularly large and prone to failing.

A new cogl_attribute_buffer_new_with_size() function has been added in
case developers need to catch OOM errors when allocating attribute buffers
whereby they can first use _buffer_new_with_size() (which doesn't take a
CoglError) followed by cogl_buffer_set_data() which will lazily allocate
the buffer storage and report OOM errors.

Reviewed-by: Neil Roberts <neil@linux.intel.com>

(cherry picked from commit f7735e141ad537a253b02afa2a8238f96340b978)

Note: since we can't break the API for Cogl 1.x then actually the main
purpose of cherry picking this patch is to keep in-line with changes
on the master branch so that we can easily cherry-pick patches.

All the api changes relating stable apis released on the 1.12 branch
have been reverted as part of cherry-picking this patch so this most
just applies all the internal plumbing changes that enable us to
correctly propagate OOM errors.

1 files changed, 10 insertions, 4 deletions

diff --git a/cogl/cogl-driver.h b/cogl/cogl-driver.h
index 36f4c7ad..6bfdcd6b 100644
--- a/cogl/cogl-driver.h
+++ b/cogl/cogl-driver.h
@@ -190,8 +190,11 @@ struct _CoglDriverVtable
 
   /* Initialize the specified region of storage of the given texture
    * with the contents of the specified bitmap region
+   *
+   * Since this may need to create the underlying storage first
+   * it may throw a NO_MEMORY error.
    */
-  void
+  CoglBool
   (* texture_2d_copy_from_bitmap) (CoglTexture2D *tex_2d,
                                    CoglBitmap *bitmap,
                                    int dst_x,
@@ -199,7 +202,8 @@ struct _CoglDriverVtable
                                    int src_x,
                                    int src_y,
                                    int width,
-                                   int height);
+                                   int height,
+                                   CoglError **error);
 
   /* Reads back the full contents of the given texture and write it to
    * @data in the given @format and with the given @rowstride.
@@ -244,7 +248,8 @@ struct _CoglDriverVtable
                         size_t offset,
                         size_t size,
                         CoglBufferAccess access,
-                        CoglBufferMapHint hints);
+                        CoglBufferMapHint hints,
+                        CoglError **error);
 
   /* Unmaps a buffer */
   void
@@ -256,7 +261,8 @@ struct _CoglDriverVtable
   (* buffer_set_data) (CoglBuffer *buffer,
                        unsigned int offset,
                        const void *data,
-                       unsigned int size);
+                       unsigned int size,
+                       CoglError **error);
 };
 
 #endif /* __COGL_DRIVER_H */