isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-27 13:22:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
a4fa5711f9
mutter/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt

1051 lines
21 KiB
Plaintext
Raw Normal View History

Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-object</FILE>
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<TITLE>The Object Interface</TITLE>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
CoglObject
cogl_object_ref
cogl_object_unref
CoglUserDataKey
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglUserDataDestroyCallback
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_object_get_user_data
cogl_object_set_user_data
</SECTION>
Adds CoglError api Although we use GLib internally in Cogl we would rather not leak GLib api through Cogl's own api, except through explicitly namespaced cogl_glib_ / cogl_gtype_ feature apis. One of the benefits we see to not leaking GLib through Cogl's public API is that documentation for Cogl won't need to first introduce the Glib API to newcomers, thus hopefully lowering the barrier to learning Cogl. This patch provides a Cogl specific typedef for reporting runtime errors which by no coincidence matches the typedef for GError exactly. If Cogl is built with --enable-glib (default) then developers can even safely assume that a CoglError is a GError under the hood. This patch also enforces a consistent policy for when NULL is passed as an error argument and an error is thrown. In this case we log the error and abort the application, instead of silently ignoring it. In common cases where nothing has been implemented to handle a particular error and/or where applications are just printing the error and aborting themselves then this saves some typing. This also seems more consistent with language based exceptions which usually cause a program to abort if they are not explicitly caught (which passing a non-NULL error signifies in this case) Since this policy for NULL error pointers is stricter than the standard GError convention, there is a clear note in the documentation to warn developers that are used to using the GError api. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit b068d5ea09ab32c37e8c965fc8582c85d1b2db46) Note: Since we can't change the Cogl 1.x api the patch was changed to not rename _error_quark() functions to be _error_domain() functions and although it's a bit ugly, instead of providing our own CoglError type that's compatible with GError we simply #define CoglError to GError unless Cogl is built with glib disabled. Note: this patch does technically introduce an API break since it drops the cogl_error_get_type() symbol generated by glib-mkenum (Since the CoglError enum was replaced by a CoglSystemError enum) but for now we are assuming that this will not affect anyone currently using the Cogl API. If this does turn out to be a problem in practice then we would be able to fix this my manually copying an implementation of cogl_error_get_type() generated by glib-mkenum into a compatibility source file and we could also define the original COGL_ERROR_ enums for compatibility too. Note: another minor concern with cherry-picking this patch to the 1.14 branch is that an api scanner would be lead to believe that some APIs have changed, and for example the gobject-introspection parser which understands the semantics of GError will not understand the semantics of CoglError. We expect most people that have tried to use gobject-introspection with Cogl already understand though that it is not well suited to generating bindings of the Cogl api anyway and we aren't aware or anyone depending on such bindings for apis involving GErrors. (GnomeShell only makes very-very minimal use of Cogl via the gjs bindings for the cogl_rectangle and cogl_color apis.) The main reason we have cherry-picked this patch to the 1.14 branch even given the above concerns is that without it it would become very awkward for us to cherry-pick other beneficial patches from master.
2012-08-31 18:28:27 +00:00
<SECTION>
<FILE>cogl-error</FILE>
<TITLE>Exception handling</TITLE>
CoglError
cogl_error_matches
cogl_error_free
cogl_error_copy
COGL_GLIB_ERROR
</SECTION>
doc: Populate cogl-types a bit more and move it to the general section I just added the general types creating warnings in the current state of the documentation (ie the ones references by already documented functions) and moved the section from the 'Utility' section to the 'General' section which I believe is a better fit as they are used by more than one type and not really utilities. (cherry picked from commit c51b147789763863ef32482d7ffa936160ed7c93)
2012-12-31 16:08:12 +00:00
<SECTION>
<FILE>cogl-types</FILE>
<TITLE>Common Types</TITLE>
<SUBSECTION>
CoglVertexP2
CoglVertexP3
CoglVertexP2C4
CoglVertexP3C4
CoglVertexP2T2
CoglVertexP3T2
CoglVertexP2T2C4
CoglVertexP3T2C4
CoglVerticesMode
<SUBSECTION>
CoglFuncPtr
CoglPixelFormat
CoglBufferTarget
CoglBufferBit
CoglAttributeType
CoglColorMask
doc: Fix the remaining broken internal cross-references Symbols changed names, %1 makes gtk-doc sad and some referenced symbols were missing in the -sections.txt file. (cherry picked from commit c12919c321186ac7b223bc4f82c588ca2f199d67)
2012-12-31 23:26:11 +00:00
<SUBSECTION>
CoglTextureFlags
doc: Populate cogl-types a bit more and move it to the general section I just added the general types creating warnings in the current state of the documentation (ie the ones references by already documented functions) and moved the section from the 'Utility' section to the 'General' section which I believe is a better fit as they are used by more than one type and not really utilities. (cherry picked from commit c51b147789763863ef32482d7ffa936160ed7c93)
2012-12-31 16:08:12 +00:00
<SUBSECTION>
CoglBool
</SECTION>
docs: Add CoglRenderer documentation to 2.0 reference This lists the cogl_renderer symbols in the cogl-sections.txt for the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:45:26 +00:00
<SECTION>
<FILE>cogl-renderer</FILE>
<TITLE>CoglRenderer: Connect to a backend renderer</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
CoglRenderer
cogl_is_renderer
<SUBSECTION>
docs: Add CoglRenderer documentation to 2.0 reference This lists the cogl_renderer symbols in the cogl-sections.txt for the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:45:26 +00:00
cogl_renderer_new
renderer: Add cogl_renderer_get_n_fragment_texture_units() Add a method on the renderer to know how many texture image units are accessible from fragment shaders. https://bugzilla.gnome.org/show_bug.cgi?id=657347 Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-08-25 16:26:44 +00:00
cogl_renderer_get_n_fragment_texture_units
docs: Add CoglRenderer documentation to 2.0 reference This lists the cogl_renderer symbols in the cogl-sections.txt for the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:45:26 +00:00
cogl_renderer_connect
doc: Fix the remaining broken internal cross-references Symbols changed names, %1 makes gtk-doc sad and some referenced symbols were missing in the -sections.txt file. (cherry picked from commit c12919c321186ac7b223bc4f82c588ca2f199d67)
2012-12-31 23:26:11 +00:00
<SUBSECTION>
CoglWinsysID
cogl_renderer_set_winsys_id
cogl_renderer_get_winsys_id
CoglRendererConstraint
cogl_renderer_add_constraint
cogl_renderer_remove_constraint
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<SUBSECTION>
work towards consistent platform file/symbol naming we've got into a bit of a mess with how we name platform specific symbols and files, so this is a first pass at trying to tidy that up. All platform specific symbols should be named like cogl_<platform>_symbol_name and similarly files should be named like cogl-<platform>-filename.c This patch tackles the X11 specific renderer/display APIs as a start. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-28 13:16:24 +00:00
cogl_xlib_renderer_set_foreign_display
cogl_xlib_renderer_get_foreign_display
docs: Add CoglRenderer documentation to 2.0 reference This lists the cogl_renderer symbols in the cogl-sections.txt for the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:45:26 +00:00
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<SUBSECTION>
replace public native_event APIs with typesafe APIs This adds Xlib and Win32 typesafe replacements for cogl_renderer_handle_native_event, cogl_renderer_add_native_filter, cogl_renderer_remove_native_filter. The old functions are kept as an implementation detail so we can share code. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-28 12:38:50 +00:00
CoglXlibFilterFunc
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglFilterReturn
doc: The filter related functions have lost '_native' (cherry picked from commit f4f4725d651d9e0433c7926470fa6a5c72ebd471)
2012-12-30 17:37:38 +00:00
cogl_xlib_renderer_add_filter
cogl_xlib_renderer_remove_filter
cogl_xlib_renderer_handle_event
replace public native_event APIs with typesafe APIs This adds Xlib and Win32 typesafe replacements for cogl_renderer_handle_native_event, cogl_renderer_add_native_filter, cogl_renderer_remove_native_filter. The old functions are kept as an implementation detail so we can share code. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-28 12:38:50 +00:00
<SUBSECTION>
CoglWin32FilterFunc
doc: The filter related functions have lost '_native' (cherry picked from commit f4f4725d651d9e0433c7926470fa6a5c72ebd471)
2012-12-30 17:37:38 +00:00
cogl_win32_renderer_add_filter
cogl_win32_renderer_remove_filter
cogl_win32_renderer_handle_event
win32: Automatically process windows messages when using a GMainLoop Previously the WGL winsys was expecting the application to send all windows messages to Cogl via the cogl_win32_renderer_handle_event function. When using a GLib main loop we can make this work transparently to the application with a GSource for the magic G_WIN32_MSG_HANDLE file descriptor. That causes the GMainLoop to wake up whenever a message is available. This patch makes the WGL winsys add that magic value as a source fd. This will only have any meaning if the application is using glib, but it shouldn't matter because the cogl_poll_renderer_get_info function is documented to only work on Unix-based winsys's anyway. This patch is an API break because by default Cogl will now start stealing all of the Windows messages. Something like Clutter that wants to handle its own event retrieval would now need to call cogl_win32_renderer_set_event_retrieval_enabled to stop Cogl from stealing the events. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 99a7f84d7149f24f3e86c5d3562f9f2632ff6df8)
2013-05-14 14:43:04 +00:00
cogl_win32_renderer_set_event_retrieval_enabled
docs: Add CoglRenderer documentation to 2.0 reference This lists the cogl_renderer symbols in the cogl-sections.txt for the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:45:26 +00:00
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<SUBSECTION>
Updates wayland symbol names to be consistent This updates the public wayland symbols to follow the pattern cogl_wayland_blah instead of cogl_blah_wayland. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-28 13:57:05 +00:00
cogl_wayland_renderer_set_foreign_display
wayland: Add API to prevent Cogl from dispatching the wayland display This adds cogl_wayland_renderer_set_event_dispatch_enabled() which can be used to prevent Cogl from adding the socket for the Wayland display to its list of file descriptors to poll. This can be used in applications that want to integrate Cogl with existing code that is reading from the Wayland socket itself. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit f5b8d98676ab3e90ad80459019c737ec2ff90aa4)
2013-07-04 12:14:04 +00:00
cogl_wayland_renderer_set_event_dispatch_enabled
Updates wayland symbol names to be consistent This updates the public wayland symbols to follow the pattern cogl_wayland_blah instead of cogl_blah_wayland. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-28 13:57:05 +00:00
cogl_wayland_renderer_get_display
docs: Add CoglRenderer documentation to 2.0 reference This lists the cogl_renderer symbols in the cogl-sections.txt for the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:45:26 +00:00
</SECTION>
docs: Add swap-chain/onscreen-template to 2.0 reference This adds the cogl_swap_chain and cogl_onscreen_template symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:54:26 +00:00
<SECTION>
<FILE>cogl-swap-chain</FILE>
<TITLE>CoglSwapChain: Describe a set of back buffers for flipping between</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
CoglSwapChain
cogl_is_swap_chain
<SUBSECTION>
docs: Add swap-chain/onscreen-template to 2.0 reference This adds the cogl_swap_chain and cogl_onscreen_template symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:54:26 +00:00
cogl_swap_chain_new
cogl_swap_chain_set_has_alpha
cogl_swap_chain_set_length
</SECTION>
<SECTION>
<FILE>cogl-onscreen-template</FILE>
<TITLE>CoglOnscreenTemplate: Describe a template for onscreen framebuffers</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
CoglOnscreenTemplate
cogl_is_onscreen_template
<SUBSECTION>
docs: Add swap-chain/onscreen-template to 2.0 reference This adds the cogl_swap_chain and cogl_onscreen_template symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:54:26 +00:00
cogl_onscreen_template_new
</SECTION>
docs: Adds CoglDisplay symbols to 2.0 reference Adds the cogl_display symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:50:34 +00:00
<SECTION>
<FILE>cogl-display</FILE>
<TITLE>CoglDisplay: Setup a display pipeline</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
CoglDisplay
cogl_is_display
<SUBSECTION>
docs: Adds CoglDisplay symbols to 2.0 reference Adds the cogl_display symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:50:34 +00:00
cogl_display_new
display: Add an accessor to get the renderer out of a display https://bugzilla.gnome.org/show_bug.cgi?id=657347 Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-08-25 16:35:34 +00:00
cogl_display_get_renderer
docs: Adds CoglDisplay symbols to 2.0 reference Adds the cogl_display symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:50:34 +00:00
cogl_display_setup
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<SUBSECTION>
docs: Adds CoglDisplay symbols to 2.0 reference Adds the cogl_display symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:50:34 +00:00
cogl_gdl_display_set_plane
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<SUBSECTION>
docs: Adds CoglDisplay symbols to 2.0 reference Adds the cogl_display symbols to the experimental 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:50:34 +00:00
cogl_wayland_display_set_compositor_display
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-context</FILE>
<TITLE>The Top-Level Context</TITLE>
<SUBSECTION>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglContext
Add the missing cogl_is_context() function This was missing from the CoglContext header. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-01-04 16:55:25 +00:00
cogl_is_context
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
cogl_context_new
context: Add an accessor to get display associated with the context https://bugzilla.gnome.org/show_bug.cgi?id=657347 Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-08-25 16:39:35 +00:00
cogl_context_get_display
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
features: Support more than 32 features! Currently features are represented as bits in a 32bit mask so we obviously can't have more than 32 features with that approach. The new approach is to use the COGL_FLAGS_ macros which lets us handle bitmasks without a size limit and we change the public api to accept individual feature enums instead of a mask. This way there is no limit on the number of features we can add to Cogl. Instead of using cogl_features_available() there is a new cogl_has_feature() function and for checking multiple features there is cogl_has_features() which takes a zero terminated vararg list of features. In addition to being able to check for individual features this also adds a way to query all the features currently available via cogl_foreach_feature() which will call a callback for each feature. Since the new functions take an explicit context pointer there is also no longer any ambiguity over when users can first start to query features. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-12 21:31:12 +00:00
<SUBSECTION>
CoglFeatureID
cogl_has_feature
cogl_has_features
CoglFeatureCallback
cogl_foreach_feature
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SUBSECTION>
cogl_push_matrix
cogl_pop_matrix
cogl_scale
cogl_translate
cogl_rotate
cogl_transform
cogl_frustum
cogl_perspective
cogl_ortho
<SUBSECTION>
cogl_get_modelview_matrix
cogl_set_modelview_matrix
cogl_get_projection_matrix
cogl_set_projection_matrix
cogl_set_viewport
cogl_get_viewport
<SUBSECTION>
cogl_set_source
cogl_set_source_color
cogl_set_source_color4ub
cogl_set_source_color4f
cogl_set_source_texture
cogl_get_source
cogl_push_source
cogl_pop_source
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<SUBSECTION>
COGL_TYPE_BUFFER_BIT
cogl_clear
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SUBSECTION>
CoglReadPixelsFlags
cogl_read_pixels
<SUBSECTION>
cogl_flush
<SUBSECTION Standard>
COGL_TYPE_ATTRIBUTE_TYPE
COGL_TYPE_BLEND_STRING_ERROR
COGL_TYPE_BUFFER_ACCESS
COGL_TYPE_BUFFER_TARGET
COGL_TYPE_BUFFER_UPDATE_HINT
COGL_TYPE_BUFFER_USAGE_HINT
COGL_TYPE_DEBUG_FLAGS
COGL_TYPE_DRIVER_ERROR
COGL_TYPE_FEATURE_FLAGS
COGL_TYPE_INDICES_TYPE
COGL_TYPE_PIXEL_FORMAT
COGL_TYPE_READ_PIXELS_FLAGS
COGL_TYPE_TEXTURE_FLAGS
COGL_TYPE_VERTICES_MODE
<SUBSECTION Private>
COGL_DRIVER_ERROR
CoglDriverError
cogl_attribute_type_get_type
cogl_buffer_bit_get_type
cogl_buffer_target_get_type
cogl_debug_flags_get_type
cogl_driver_error_get_type
cogl_feature_flags_get_type
cogl_fixed_get_type
cogl_fog_mode_get_type
cogl_indices_type_get_type
cogl_pixel_format_get_type
cogl_read_pixels_flags_get_type
cogl_shader_type_get_type
cogl_texture_flags_get_type
cogl_vertices_mode_get_type
COGL_AFIRST_BIT
COGL_A_BIT
COGL_BGR_BIT
COGL_PREMULT_BIT
</SECTION>
Add support for main loop integration This adds two new functions: void cogl_poll_get_info (CoglContext *context, CoglPollFD **poll_fds, int *n_poll_fds, gint64 *timeout); void cogl_poll_dispatch (CoglContext *context, const CoglPollFD *poll_fds, int n_poll_fds); The application is expected to call the first function whenever it is about to block to go idle, and the second function whenever it comes out of idle. This gives Cogl winsys's the ability poll file descriptors for events. For example when handing swap complete notifications, it can report that it needs to block on a file descriptor. The two functions are backed by winsys virtual functions. There are currently no implementations. The default handler for get_info just reports no file descriptors and an infinite timeout. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-16 17:49:28 +00:00
<SECTION>
<FILE>cogl-poll</FILE>
Move event polling into CoglRenderer This updates the cogl_poll_ apis to allow dispatching events before we have a CoglContext and to also enables pollfd state to be changed in a more add-hoc way by different Cogl components by replacing the winsys->get_poll_info with _cogl_poll_renderer_add/remove_fd functions and a winsys->get_dispatch_timeout vfunc. One of the intentions here is that applications should be able to run their mainloop before creating a CoglContext to potentially get events relating to CoglOutputs. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 667e58c9cb2662aef5f44e580a9eda42dc8d0176)
2013-04-16 22:46:03 +00:00
<TITLE>Main loop integration</TITLE>
Add support for main loop integration This adds two new functions: void cogl_poll_get_info (CoglContext *context, CoglPollFD **poll_fds, int *n_poll_fds, gint64 *timeout); void cogl_poll_dispatch (CoglContext *context, const CoglPollFD *poll_fds, int n_poll_fds); The application is expected to call the first function whenever it is about to block to go idle, and the second function whenever it comes out of idle. This gives Cogl winsys's the ability poll file descriptors for events. For example when handing swap complete notifications, it can report that it needs to block on a file descriptor. The two functions are backed by winsys virtual functions. There are currently no implementations. The default handler for get_info just reports no file descriptors and an infinite timeout. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-16 17:49:28 +00:00
CoglPollFDEvent
CoglPollFD
Move event polling into CoglRenderer This updates the cogl_poll_ apis to allow dispatching events before we have a CoglContext and to also enables pollfd state to be changed in a more add-hoc way by different Cogl components by replacing the winsys->get_poll_info with _cogl_poll_renderer_add/remove_fd functions and a winsys->get_dispatch_timeout vfunc. One of the intentions here is that applications should be able to run their mainloop before creating a CoglContext to potentially get events relating to CoglOutputs. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 667e58c9cb2662aef5f44e580a9eda42dc8d0176)
2013-04-16 22:46:03 +00:00
cogl_poll_renderer_get_info
cogl_poll_renderer_dispatch
Add a utility to make a GSource out of a CoglContext The GSource is created using cogl_glib_source_new which takes a pointer to a CoglContext. The source calls cogl_poll_get_info() in its prepare function and cogl_poll_dispatch() in its dispatch function. The poll FDs on the source are updated according to what Cogl reports. The header is only included and the source only compiled if Cogl is configured with GLib support. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-19 14:38:28 +00:00
cogl_glib_source_new
Move event polling into CoglRenderer This updates the cogl_poll_ apis to allow dispatching events before we have a CoglContext and to also enables pollfd state to be changed in a more add-hoc way by different Cogl components by replacing the winsys->get_poll_info with _cogl_poll_renderer_add/remove_fd functions and a winsys->get_dispatch_timeout vfunc. One of the intentions here is that applications should be able to run their mainloop before creating a CoglContext to potentially get events relating to CoglOutputs. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 667e58c9cb2662aef5f44e580a9eda42dc8d0176)
2013-04-16 22:46:03 +00:00
cogl_glib_renderer_source_new
Add support for main loop integration This adds two new functions: void cogl_poll_get_info (CoglContext *context, CoglPollFD **poll_fds, int *n_poll_fds, gint64 *timeout); void cogl_poll_dispatch (CoglContext *context, const CoglPollFD *poll_fds, int n_poll_fds); The application is expected to call the first function whenever it is about to block to go idle, and the second function whenever it comes out of idle. This gives Cogl winsys's the ability poll file descriptors for events. For example when handing swap complete notifications, it can report that it needs to block on a file descriptor. The two functions are backed by winsys virtual functions. There are currently no implementations. The default handler for get_info just reports no file descriptors and an infinite timeout. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-16 17:49:28 +00:00
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<FILE>cogl-attribute</FILE>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<TITLE>Vertex Attributes</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglAttribute
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
cogl_attribute_new
cogl_is_attribute
attribute: Add the buffer and normalized property APIs to the header The header was missing declarations for cogl_attribute_{get,set}_{buffer,normalized}. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-01 12:33:30 +00:00
cogl_attribute_set_normalized
cogl_attribute_get_normalized
cogl_attribute_get_buffer
cogl_attribute_set_buffer
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
<SECTION>
<FILE>cogl-indices</FILE>
<TITLE>Indices</TITLE>
doc: Declare CoglIndices Types need to be declare to be cross-referenceable. Use the opportunity to reorganise the symbols in subsections. (cherry picked from commit 95be47bc2aeea208c28d7df0b82aa63cc132f71e)
2012-12-30 16:43:44 +00:00
<SUBSECTION>
CoglIndices
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_is_indices
doc: Declare CoglIndices Types need to be declare to be cross-referenceable. Use the opportunity to reorganise the symbols in subsections. (cherry picked from commit 95be47bc2aeea208c28d7df0b82aa63cc132f71e)
2012-12-30 16:43:44 +00:00
<SUBSECTION>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglIndicesType
doc: Declare CoglIndices Types need to be declare to be cross-referenceable. Use the opportunity to reorganise the symbols in subsections. (cherry picked from commit 95be47bc2aeea208c28d7df0b82aa63cc132f71e)
2012-12-30 16:43:44 +00:00
cogl_indices_new
doc: Fix the remaining broken internal cross-references Symbols changed names, %1 makes gtk-doc sad and some referenced symbols were missing in the -sections.txt file. (cherry picked from commit c12919c321186ac7b223bc4f82c588ca2f199d67)
2012-12-31 23:26:11 +00:00
<SUBSECTION>
cogl_get_rectangle_indices
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
<SECTION>
<FILE>cogl-primitive</FILE>
<TITLE>Primitives</TITLE>
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
CoglPrimitive
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_primitive_new
docs: Updates cogl_primitive_new_xyz symbols listing Previously we had functions named like cogl_primitive_new_with_xyz_attributes() but at some point we renamed them all to functions named like cogl_primitive_new_xyz() instead. This updates the -sections.txt symbol listing to list the new names. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-01-16 20:58:22 +00:00
cogl_primitive_new_with_attributes
cogl_primitive_new_p2
cogl_primitive_new_p3
cogl_primitive_new_p2c4
cogl_primitive_new_p3c4
cogl_primitive_new_p2t2
cogl_primitive_new_p3t2
cogl_primitive_new_p2t2c4
cogl_primitive_new_p3t2c4
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_is_primitive
cogl_primitive_get_first_vertex
cogl_primitive_set_first_vertex
cogl_primitive_get_n_vertices
cogl_primitive_set_n_vertices
cogl_primitive_get_mode
cogl_primitive_set_mode
cogl_primitive_set_attributes
Add cogl_primitive_get_indices() This adds a public getter for the indices property of CoglPrimitive. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-02-06 14:01:24 +00:00
cogl_primitive_get_indices
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_primitive_set_indices
Add cogl_primitive_copy() This adds a public function to make a copy of a primitive. The copy is shallow which means it will share the same attributes and attribute buffers. This could be useful for code that wants to have multiple similar primitives with slightly modified properties. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-02-06 12:52:18 +00:00
cogl_primitive_copy
Add cogl_primitive_foreach_attribute() This adds a public function to iterate the attributes of a CoglPrimitive. Previously there was no way to query back the attributes but there was methods to query back all of the other properties. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-02-06 13:29:35 +00:00
CoglPrimitiveAttributeCallback
cogl_primitive_foreach_attribute
Add _primitive_draw to replace _framebuffer_draw_primitive When splitting out the CoglPath api we saw that we would be left with inconsistent drawing apis if the drawing apis in core Cogl were lumped into the cogl_framebuffer_ api considering other Cogl sub-libraries or that others will want to create higher level drawing apis outside of Cogl but can't use the same namespace. So that we can aim for a more consistent style this adds a cogl_primitive_draw() api, comparable to cogl_path_fill() or cogl_pango_show_layout() that's intended to replace cogl_framebuffer_draw_primitive() Note: the attribute and rectangle drawing apis are still in the cogl_framebuffer_ namespace and this might potentially change but in these cases there is no single object representing the thing being drawn so it seems a more reasonable they they live in the framebuffer namespace for now. Note: the cogl_framebuffer_draw_primitive() api isn't removed by this patch so it can more conveniently be cherry picked to the 1.16 branch so we can mark it deprecated for a short while. Even though it's marked as experimental api we know that there are people using the api so we'd like to give them a chance to switch to the new api. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 418912b93ff81a47f9b38114d05335ab76277c48) Conflicts: cogl-pango/cogl-pango-display-list.c cogl/Makefile.am cogl/cogl-framebuffer.c cogl/cogl-pipeline-layer-state.h cogl/cogl2-path.c cogl/driver/gl/cogl-clip-stack-gl.c
2013-07-09 22:47:29 +00:00
cogl_primitive_draw
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
<SECTION>
<FILE>cogl-rectangle</FILE>
<TITLE>Rectangles</TITLE>
cogl_rectangle
cogl_rectangles
cogl_rectangle_with_texture_coords
cogl_rectangles_with_texture_coords
cogl_rectangle_with_multitexture_coords
</SECTION>
snippet: Add some more documentation This adds a documentation section for CoglSnippet which gives an overview of how to use them. It also fixes some syntax errors in the existing documentation and adds the missing pipeline functions for adding snippets to the documentation sections file. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-06 19:17:03 +00:00
<SECTION>
<FILE>cogl-snippet</FILE>
<TITLE>Shader snippets</TITLE>
CoglSnippet
CoglSnippetHook
cogl_snippet_new
cogl_snippet_get_hook
cogl_is_snippet
cogl_snippet_set_declarations
cogl_snippet_get_declarations
cogl_snippet_set_pre
cogl_snippet_get_pre
cogl_snippet_set_replace
cogl_snippet_get_replace
cogl_snippet_set_post
cogl_snippet_get_post
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-primitives-deprecated</FILE>
<TITLE>Primitives (Deprecated)</TITLE>
cogl_polygon
</SECTION>
<SECTION>
<FILE>cogl-paths</FILE>
<TITLE>Path Primitives</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglPath
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_is_path
cogl_path_new
cogl_path_copy
cogl_path_move_to
cogl_path_close
cogl_path_line_to
cogl_path_curve_to
cogl_path_arc
cogl_path_rel_move_to
cogl_path_rel_line_to
cogl_path_rel_curve_to
cogl_path_line
cogl_path_polyline
cogl_path_polygon
cogl_path_rectangle
cogl_path_round_rectangle
cogl_path_ellipse
<SUBSECTION>
CoglPathFillRule
cogl_path_set_fill_rule
cogl_path_get_fill_rule
</SECTION>
doc: Expose CoglBitmap (cherry picked from commit ee97e4ae2b7ca272882a1acaa7eb6df3aed60096)
2012-12-30 16:21:38 +00:00
<SECTION>
<FILE>cogl-bitmap</FILE>
<TITLE>Bitmap</TITLE>
<SUBSECTION>
CoglBitmap
cogl_is_bitmap
<SUBSECTION>
cogl_bitmap_new_from_file
cogl_bitmap_new_from_buffer
cogl_bitmap_new_with_size
cogl_bitmap_new_for_data
<SUBSECTION>
cogl_bitmap_get_format
cogl_bitmap_get_width
cogl_bitmap_get_height
cogl_bitmap_get_rowstride
cogl_bitmap_get_buffer
cogl_bitmap_get_size_from_file
doc: Fix the remaining broken internal cross-references Symbols changed names, %1 makes gtk-doc sad and some referenced symbols were missing in the -sections.txt file. (cherry picked from commit c12919c321186ac7b223bc4f82c588ca2f199d67)
2012-12-31 23:26:11 +00:00
<SUBSECTION>
cogl_texture_new_from_bitmap
doc: Expose CoglBitmap (cherry picked from commit ee97e4ae2b7ca272882a1acaa7eb6df3aed60096)
2012-12-30 16:21:38 +00:00
<SUBSECTION>
COGL_BITMAP_ERROR
CoglBitmapError
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-texture</FILE>
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<TITLE>The Texture Interface</TITLE>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
CoglTexture
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_is_texture
<SUBSECTION>
cogl_texture_get_width
cogl_texture_get_height
cogl_texture_get_format
cogl_texture_is_sliced
cogl_texture_get_data
texture: Adds cogl_texture_set_data convenience api This adds a cogl_texture_set_data function that is basically just a convenience wrapper around cogl_texture_set_region. In the common case where you want to upload the full contents of a mipmap level though this api takes 4 less arguments (6 in total) so it's a bit simpler. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit e651dbdc4e4f03016a3dee513e3680270a4a9142)
2012-11-26 13:14:27 +00:00
cogl_texture_set_data
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_texture_set_region
Add _cogl_texture_get_type() This adds an internal function to get the type of the underlying hardware texture for any CoglTexture. It can return one of three values to represent 2D textures, 3D textures or rectangle textures. The idea is that this can be used as a replacement for cogl_texture_get_gl_texture when only the target is required to make it a bit less GL-centric. The implementation adds a new virtual function which all of the texture backends now implement. The enum is in a public header because a later patch will want to use it from the CoglPipeline API. We may want to consider making the function public too later. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-02-09 11:19:04 +00:00
CoglTextureType
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SUBSECTION Private>
COGL_TEXTURE_MAX_WASTE
</SECTION>
doc: Adds a cogl-texture-2d to the 2.0 reference manual When we make CoglTexture2D public as experimental api we forgot to add a corresponding section the experimental 2.0 reference manual. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-14 08:59:23 +00:00
<SECTION>
<FILE>cogl-texture-2d</FILE>
<TITLE>2D textures</TITLE>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
CoglTexture2D
doc: Adds a cogl-texture-2d to the 2.0 reference manual When we make CoglTexture2D public as experimental api we forgot to add a corresponding section the experimental 2.0 reference manual. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-14 08:59:23 +00:00
cogl_texture_2d_new_with_size
texture-2d: Add _new_from_file api This adds a cogl_texture_2d_new_from_file() api since we are planning to remove cogl_texture_new_from_file() but don't want to loose the convenience it had. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 10e91aa513123ed277a8d45976f8d75445d7dc9c)
2013-06-08 01:10:15 +00:00
cogl_texture_2d_new_from_file
Add constructors which take a CoglBitmap to all primitive textures This adds public constructors which take a CoglBitmap to all primitive texture types. This constructor should be considered the canonical constructor for initializing the texture with data because it should be possible to wrap any type of data in a CoglBitmap. Having at least this single constructor avoids the need to have an explosion of constructors such as new_from_data, new_from_pixel_buffer and new_from_file etc. The already available internal bitmap constructor for CoglTexture2D has had its flags parameter removed under the assumption that flags do not make sense for primitive textures. The meta constructor cogl_texture_new_from_bitmap now just explicitly calls set_auto_mipmap after constructing the texture depending on the value of the COGL_TEXTURE_NO_AUTO_MIPMAP flag. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-04-04 14:10:04 +00:00
cogl_texture_2d_new_from_bitmap
doc: Adds a cogl-texture-2d to the 2.0 reference manual When we make CoglTexture2D public as experimental api we forgot to add a corresponding section the experimental 2.0 reference manual. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-14 08:59:23 +00:00
cogl_texture_2d_new_from_data
cogl_texture_2d_new_from_foreign
cogl_is_texture_rectangle
</SECTION>
texture: Make CoglTextureRectangle experimentally public This exposes CoglTextureRectangle in the experimental cogl 2.0 api. For now we just expose a single constructor; cogl_texture_rectangle_new_with_size() but we can add more later. This is part of going work to improve our texture apis with more emphasis on providing low-level access to the varying semantics of different texture types understood by the gpu instead of only trying to present a lowest common denominator api. CoglTextureRectangle is notably useful for never being restricted to power of two sizes and for being sampled with non-normalized texture coordinates which can be convenient for use a lookup tables in glsl due to not needing separate uniforms for mapping normalized coordinates to texels. Unlike CoglTexture2D though rectangle textures can't have a mipmap and they only support the _CLAMP_TO_EDGE wrap mode. Applications wanting to use CoglTextureRectangle should first check cogl_has_feature (COGL_FEATURE_ID_TEXTURE_RECTANGLE). Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-14 08:25:12 +00:00
<SECTION>
<FILE>cogl-texture-rectangle</FILE>
<TITLE>Rectangle textures (non-normalized coordinates)</TITLE>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
CoglTextureRectangle
texture: Make CoglTextureRectangle experimentally public This exposes CoglTextureRectangle in the experimental cogl 2.0 api. For now we just expose a single constructor; cogl_texture_rectangle_new_with_size() but we can add more later. This is part of going work to improve our texture apis with more emphasis on providing low-level access to the varying semantics of different texture types understood by the gpu instead of only trying to present a lowest common denominator api. CoglTextureRectangle is notably useful for never being restricted to power of two sizes and for being sampled with non-normalized texture coordinates which can be convenient for use a lookup tables in glsl due to not needing separate uniforms for mapping normalized coordinates to texels. Unlike CoglTexture2D though rectangle textures can't have a mipmap and they only support the _CLAMP_TO_EDGE wrap mode. Applications wanting to use CoglTextureRectangle should first check cogl_has_feature (COGL_FEATURE_ID_TEXTURE_RECTANGLE). Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-14 08:25:12 +00:00
cogl_texture_rectangle_new_with_size
Add constructors which take a CoglBitmap to all primitive textures This adds public constructors which take a CoglBitmap to all primitive texture types. This constructor should be considered the canonical constructor for initializing the texture with data because it should be possible to wrap any type of data in a CoglBitmap. Having at least this single constructor avoids the need to have an explosion of constructors such as new_from_data, new_from_pixel_buffer and new_from_file etc. The already available internal bitmap constructor for CoglTexture2D has had its flags parameter removed under the assumption that flags do not make sense for primitive textures. The meta constructor cogl_texture_new_from_bitmap now just explicitly calls set_auto_mipmap after constructing the texture depending on the value of the COGL_TEXTURE_NO_AUTO_MIPMAP flag. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-04-04 14:10:04 +00:00
cogl_texture_rectangle_new_from_bitmap
texture: Make CoglTextureRectangle experimentally public This exposes CoglTextureRectangle in the experimental cogl 2.0 api. For now we just expose a single constructor; cogl_texture_rectangle_new_with_size() but we can add more later. This is part of going work to improve our texture apis with more emphasis on providing low-level access to the varying semantics of different texture types understood by the gpu instead of only trying to present a lowest common denominator api. CoglTextureRectangle is notably useful for never being restricted to power of two sizes and for being sampled with non-normalized texture coordinates which can be convenient for use a lookup tables in glsl due to not needing separate uniforms for mapping normalized coordinates to texels. Unlike CoglTexture2D though rectangle textures can't have a mipmap and they only support the _CLAMP_TO_EDGE wrap mode. Applications wanting to use CoglTextureRectangle should first check cogl_has_feature (COGL_FEATURE_ID_TEXTURE_RECTANGLE). Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-14 08:25:12 +00:00
cogl_is_texture_rectangle
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-texture-3d</FILE>
<TITLE>3D textures</TITLE>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
CoglTexture3D
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_texture_3d_new_with_size
Add constructors which take a CoglBitmap to all primitive textures This adds public constructors which take a CoglBitmap to all primitive texture types. This constructor should be considered the canonical constructor for initializing the texture with data because it should be possible to wrap any type of data in a CoglBitmap. Having at least this single constructor avoids the need to have an explosion of constructors such as new_from_data, new_from_pixel_buffer and new_from_file etc. The already available internal bitmap constructor for CoglTexture2D has had its flags parameter removed under the assumption that flags do not make sense for primitive textures. The meta constructor cogl_texture_new_from_bitmap now just explicitly calls set_auto_mipmap after constructing the texture depending on the value of the COGL_TEXTURE_NO_AUTO_MIPMAP flag. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-04-04 14:10:04 +00:00
cogl_texture_3d_new_from_bitmap
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_texture_3d_new_from_data
cogl_is_texture_3d
</SECTION>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
<SECTION>
<FILE>cogl-meta-texture</FILE>
<TITLE>High Level Meta Textures</TITLE>
CoglMetaTexture
CoglMetaTextureCallback
cogl_meta_texture_foreach_in_region
</SECTION>
Add a CoglPrimitiveTexture interface This interface represents any textures that are backed by a single texture in GL and that can be used directly with the cogl_framebuffer_draw_attributes family of functions. This currently equates to CoglTexture2D, CoglTexture3D and CoglTextureRectangle. The interface currently has only one method called cogl_primitive_set_auto_mipmap. This replaces the COGL_TEXTURE_NO_AUTO_MIPMAP flag from the CoglTextureFlags parameter in the constructors. None of the other flags in CoglTextureFlags make sense for primitive textures so it doesn't seem like a good idea to need them for primitive constructors. There is a boolean in the vtable to mark whether a texture type is primitive which the new cogl_is_primitive function uses. There is also a new texture virtual called set_auto_mipmap which is only required to be implemented for primitive textures. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-04-04 14:09:43 +00:00
<SECTION>
<FILE>cogl-primitive-texture</FILE>
<TITLE>Low-level primitive textures</TITLE>
CoglPrimitiveTexture
cogl_is_primitive_texture
cogl_primitive_texture_set_auto_mipmap
</SECTION>
texture: Make CoglSubTexture experimental public api This exposes cogl_sub_texture_new() and cogl_is_sub_texture() as experimental public API. Previously sub-textures were only exposed via cogl_texture_new_from_sub_texture() so there wasn't a corresponding CoglSubTexture type. A CoglSubTexture is a high-level texture defined as a sub-region of some other parent texture. CoglSubTextures are high level textures that implement the CoglMetaTexture interface which can be used to manually handle texture repeating. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-21 10:36:25 +00:00
<SECTION>
<FILE>cogl-sub-texture</FILE>
<TITLE>Sub Textures</TITLE>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
CoglSubTexture
texture: Make CoglSubTexture experimental public api This exposes cogl_sub_texture_new() and cogl_is_sub_texture() as experimental public API. Previously sub-textures were only exposed via cogl_texture_new_from_sub_texture() so there wasn't a corresponding CoglSubTexture type. A CoglSubTexture is a high-level texture defined as a sub-region of some other parent texture. CoglSubTextures are high level textures that implement the CoglMetaTexture interface which can be used to manually handle texture repeating. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-10-21 10:36:25 +00:00
cogl_sub_texture_new
cogl_is_sub_texture
</SECTION>
Expose CoglAtlasTexture api This exposes the CoglAtlasTexture api, making the following public: cogl_atlas_texture_new_with_size cogl_atlas_texture_new_from_file cogl_atlas_texture_new_from_data cogl_atlas_texture_new_from_bitmap The plan is to remove auto-texture apis like cogl_texture_new_from_file since they are a bit too magic, but that means we need an explicit way for users to allocate texture that will go in the atlas. Although the _new_from_file() api is arguably redundant since you can use _bitmap_new_from_file() followed by _atlas_texture_new_from_bitmap() we don't want to loose any of the convenience that cogl_texture_new_from_file() had. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit fe515e6063ba4c3ddb5cd00d2c8527d9a6336a12) Conflicts: cogl/Makefile.am
2013-06-08 00:58:05 +00:00
<SECTION>
<FILE>cogl-atlas-texture</FILE>
<TITLE>Atlas Textures</TITLE>
CoglAtlasTexture
cogl_atlas_texture_new_with_size
cogl_atlas_texture_new_from_file
cogl_atlas_texture_new_from_data
cogl_atlas_texture_new_from_bitmap
cogl_is_atlas_texture
</SECTION>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
<SECTION>
<FILE>cogl-texture-2d-sliced</FILE>
<TITLE>Sliced Textures</TITLE>
CoglTexture2DSliced
cogl_texture_2d_sliced_new_with_size
2d-sliced: add _new_from_file/data/bitmap apis This adds cogl_texture_2d_sliced_new_from_bitmap/data/file apis in preparation for removing the cogl_texture_new_from_bitmap/file apis that are considered a bit too magic, but we don't want to loose the convenience they have. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 218da8e1349d7658f45c6933b9736c0d32941b8b) Conflicts: cogl/cogl-auto-texture.c
2013-06-08 17:52:20 +00:00
cogl_texture_2d_sliced_new_from_file
cogl_texture_2d_sliced_new_from_data
cogl_texture_2d_sliced_new_from_bitmap
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
cogl_is_texture_2d_sliced
</SECTION>
<SECTION>
<FILE>cogl-texture-pixmap-x11</FILE>
<TITLE>X11 Texture From Pixmap</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
CoglTexturePixmapX11
cogl_is_texture_pixmap_x11
<SUBSECTION>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
cogl_texture_pixmap_x11_new
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
cogl_texture_pixmap_x11_update_area
cogl_texture_pixmap_x11_is_using_tfp_extension
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglTexturePixmapX11ReportLevel
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 17:31:05 +00:00
cogl_texture_pixmap_x11_set_damage_object
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-framebuffer</FILE>
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<TITLE>CoglFramebuffer: The Framebuffer Interface</TITLE>
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
CoglFramebuffer
COGL_FRAMEBUFFER
cogl_framebuffer_allocate
cogl_framebuffer_get_width
cogl_framebuffer_get_height
cogl_framebuffer_set_viewport
cogl_framebuffer_get_viewport_x
cogl_framebuffer_get_viewport_y
cogl_framebuffer_get_viewport_width
cogl_framebuffer_get_viewport_height
cogl_framebuffer_get_viewport4fv
Fix some documentation problems • The documentation for the framebuffer and texture interfaces had a mis-matching open and close <note> tag so DocBook got upset and the whole documentation disappeared. • A lot of symbols from the cogl_framebuffer_* interface were missing from the cogl-2.0-experimental-sections.txt file. • cogl_framebuffer_frustum had the wrong version in its Since tag: Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-20 13:17:07 +00:00
cogl_framebuffer_get_color_format
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
cogl_framebuffer_get_red_bits
cogl_framebuffer_get_green_bits
cogl_framebuffer_get_blue_bits
doc: Fix copy/paste error for cogl_framebuffer_get_alpha_bits() (cherry picked from commit 04fbddd2fa02669046adfed0c64c301df1da4c7c)
2012-12-30 19:30:02 +00:00
cogl_framebuffer_get_alpha_bits
Add a public cogl_framebuffer_get_depth_bits() function Cogl publicly exposes the depth buffer state so we might as well have a function to query the number of depth bits of a framebuffer. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 853143eb10387f50f8d32cf09af31b8829dc1e01)
2012-12-13 15:47:35 +00:00
cogl_framebuffer_get_depth_bits
Adds ColorMask support to Cogl This adds CoglPipeline and CoglFramebuffer support for setting a color mask which is a bit mask defining which color channels should be written to the current framebuffer. The final color mask is the intersection of the framebuffer color mask and the pipeline color mask. The framebuffer mask affects all rendering to the framebuffer while the pipeline masks can be used to affect individual primitives. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-07-11 01:27:54 +00:00
cogl_framebuffer_get_color_mask
cogl_framebuffer_set_color_mask
doc: Fix a couple of renamed symbols cogl_framebuffer_{get,set}_point_samples_per_pixel() have lost the 'point_' part. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 3c8bcf391090ad0c5f65f300458bfc901fd62800)
2012-05-12 08:21:03 +00:00
cogl_framebuffer_get_samples_per_pixel
cogl_framebuffer_set_samples_per_pixel
Fix some documentation problems • The documentation for the framebuffer and texture interfaces had a mis-matching open and close <note> tag so DocBook got upset and the whole documentation disappeared. • A lot of symbols from the cogl_framebuffer_* interface were missing from the cogl-2.0-experimental-sections.txt file. • cogl_framebuffer_frustum had the wrong version in its Since tag: Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-20 13:17:07 +00:00
cogl_framebuffer_resolve_samples
cogl_framebuffer_resolve_samples_region
framebuffer: Adds a context getter for CoglFramebuffer This adds a function to query what CoglContext a given framebuffer belongs too. This can be useful if you pass framebuffer pointers around and at some point you want to create another framebuffer as part of the same context as a given framebuffer without assuming there is a single default context. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-08-02 14:24:02 +00:00
cogl_framebuffer_get_context
framebuffer: Make framebuffer_clear APIs public experimental This makes cogl_framebuffer_clear and cogl_framebuffer_clear4f public as experimental API. Since these functions take explicit framebuffer pointers you don't need to push/pop a framebuffer just to clear it. Also these functions are implicitly tied to a specific CoglContext via the framebuffer pointer unlike cogl_clear. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-08-02 15:27:59 +00:00
cogl_framebuffer_clear
cogl_framebuffer_clear4f
Add a public cogl_framebuffer_read_pixels_into_bitmap This adds a public function to read pixels from a framebuffer into a CoglBitmap. This replaces the internal function _cogl_read_pixels_with_rowstride because a CoglBitmap contains a rowstride so it can be used for the same purpose. A CoglBitmap already has public API to make one that points to a CoglPixelBuffer so this function can be used to read pixels into a PBO. It also avoids the need to push the framebuffer on to the context's stack so it provides a function which can be used in the 2.0 API after the stack is removed. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-02-25 19:23:51 +00:00
cogl_framebuffer_read_pixels_into_bitmap
Add cogl_framebuffer_read_pixels() This adds a public convenience wrapper around cogl_framebuffer_read_pixels_into_bitmap which allocates a temporary CoglBitmap to read into the application's own buffer. This can only be used for the 99% common case where the rowstride is exactly the bpp*width and the source is the color buffer. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-19 14:18:25 +00:00
cogl_framebuffer_read_pixels
Fix some documentation problems • The documentation for the framebuffer and texture interfaces had a mis-matching open and close <note> tag so DocBook got upset and the whole documentation disappeared. • A lot of symbols from the cogl_framebuffer_* interface were missing from the cogl-2.0-experimental-sections.txt file. • cogl_framebuffer_frustum had the wrong version in its Since tag: Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-20 13:17:07 +00:00
cogl_framebuffer_set_dither_enabled
cogl_framebuffer_get_dither_enabled
framebuffer: Add cogl_framebuffer draw methods This adds cogl_framebuffer_ apis for drawing attributes and primitives that replace corresponding apis that depend on the default CoglContext. This is part of the on going effort to adapt the Cogl api so it no longer depends on a global context variable. All the new drawing functions also take an explicit pipeline argument since we are also aiming to avoid being a stateful api like Cairo and OpenGL. Being stateless makes it easier for orthogonal components to share access to the GPU. Being stateless should also minimize any impedance miss-match for those wanting to build higher level stateless apis on top of Cogl. Note: none of the legacy, global state options such as cogl_set_depth_test_enabled(), cogl_set_backface_culling_enabled() or cogl_program_use() are supported by these new drawing apis and if set will simply be silently ignored. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-01-08 02:59:04 +00:00
<SUBSECTION>
Adds cogl_framebuffer_draw_[*_]rectangle functions This adds experimental 2.0 api replacements for the cogl_rectangle[_*] functions that don't depend on having a current pipeline set on the context via cogl_{set,push}_source() or having a current framebuffer set on the context via cogl_push_framebuffer(). The aim for 2.0 is to switch away from having a statefull context that affects drawing to having framebuffer drawing apis that are explicitly passed a framebuffer and pipeline. To test this change several of the conformance tests were updated to use this api instead of cogl_rectangle and cogl_rectangle_with_texture_coords. Since it's quite laborious going through all of the conformance tests the opportunity was taken to make other clean ups in the conformance tests to replace other uses of 1.x api with experimental 2.0 api so long as that didn't affect what was being tested.
2012-03-16 19:54:13 +00:00
cogl_framebuffer_draw_rectangle
cogl_framebuffer_draw_textured_rectangle
cogl_framebuffer_draw_multitextured_rectangle
cogl_framebuffer_draw_rectangles
cogl_framebuffer_draw_textured_rectangles
Replace cogl_path_{stroke,fill} with framebuffer API The existing functions for stroking and filling a path depend on the global framebuffer and source stacks. These are now replaced with cogl_framebuffer_{stroke,fill}_path which get explicitly passed the framebuffer and pipeline. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 713a8f8160bc5884b091c69eb7a84b069e0950e6)
2012-04-18 14:57:33 +00:00
cogl_framebuffer_stroke_path
cogl_framebuffer_fill_path
framebuffer: Add cogl_framebuffer draw methods This adds cogl_framebuffer_ apis for drawing attributes and primitives that replace corresponding apis that depend on the default CoglContext. This is part of the on going effort to adapt the Cogl api so it no longer depends on a global context variable. All the new drawing functions also take an explicit pipeline argument since we are also aiming to avoid being a stateful api like Cairo and OpenGL. Being stateless makes it easier for orthogonal components to share access to the GPU. Being stateless should also minimize any impedance miss-match for those wanting to build higher level stateless apis on top of Cogl. Note: none of the legacy, global state options such as cogl_set_depth_test_enabled(), cogl_set_backface_culling_enabled() or cogl_program_use() are supported by these new drawing apis and if set will simply be silently ignored. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-01-08 02:59:04 +00:00
<SUBSECTION>
doc: Fix the remaining broken internal cross-references Symbols changed names, %1 makes gtk-doc sad and some referenced symbols were missing in the -sections.txt file. (cherry picked from commit c12919c321186ac7b223bc4f82c588ca2f199d67)
2012-12-31 23:26:11 +00:00
cogl_framebuffer_discard_buffers
framebuffer: Adds experimental _finish() API This adds a new experimental function, cogl_framebuffer_finish(), which can be used to explicitly synchronize the CPU with the GPU. It's rare that this level of explicit synchronization is desirable but for example it can be useful during performance analysys to make sure measurements reflect the working time of the GPU not just the time to queue commands. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-09-28 14:19:38 +00:00
cogl_framebuffer_finish
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
Fix some documentation problems • The documentation for the framebuffer and texture interfaces had a mis-matching open and close <note> tag so DocBook got upset and the whole documentation disappeared. • A lot of symbols from the cogl_framebuffer_* interface were missing from the cogl-2.0-experimental-sections.txt file. • cogl_framebuffer_frustum had the wrong version in its Since tag: Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-20 13:17:07 +00:00
<SUBSECTION>
cogl_framebuffer_push_matrix
cogl_framebuffer_pop_matrix
cogl_framebuffer_identity_matrix
cogl_framebuffer_scale
cogl_framebuffer_translate
cogl_framebuffer_rotate
Add functions to directly transform from a euler or a quaternion This adds the following new functions to apply a rotation described by a euler or a quaternion to either a CoglMatrix or directly to the modelview stack of a framebuffer: cogl_matrix_rotate_quaternion cogl_matrix_rotate_euler cogl_framebuffer_rotate_quaternion cogl_framebuffer_rotate_euler The direct framebuffer functions have corresponding functions in the CoglMatrixStack to store an entry describing the rotation. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 5064315678b496395e1d01f266f322d73e55e324)
2012-05-17 21:22:01 +00:00
cogl_framebuffer_rotate_euler
cogl_framebuffer_rotate_quaternion
Fix some documentation problems • The documentation for the framebuffer and texture interfaces had a mis-matching open and close <note> tag so DocBook got upset and the whole documentation disappeared. • A lot of symbols from the cogl_framebuffer_* interface were missing from the cogl-2.0-experimental-sections.txt file. • cogl_framebuffer_frustum had the wrong version in its Since tag: Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-20 13:17:07 +00:00
cogl_framebuffer_transform
cogl_framebuffer_get_modelview_matrix
cogl_framebuffer_set_modelview_matrix
<SUBSECTION>
cogl_framebuffer_perspective
cogl_framebuffer_frustum
cogl_framebuffer_orthographic
cogl_framebuffer_get_projection_matrix
cogl_framebuffer_set_projection_matrix
<SUBSECTION>
cogl_framebuffer_push_scissor_clip
cogl_framebuffer_push_rectangle_clip
doc: Fix the remaining broken internal cross-references Symbols changed names, %1 makes gtk-doc sad and some referenced symbols were missing in the -sections.txt file. (cherry picked from commit c12919c321186ac7b223bc4f82c588ca2f199d67)
2012-12-31 23:26:11 +00:00
cogl_framebuffer_push_path_clip
Fix some documentation problems • The documentation for the framebuffer and texture interfaces had a mis-matching open and close <note> tag so DocBook got upset and the whole documentation disappeared. • A lot of symbols from the cogl_framebuffer_* interface were missing from the cogl-2.0-experimental-sections.txt file. • cogl_framebuffer_frustum had the wrong version in its Since tag: Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-20 13:17:07 +00:00
cogl_framebuffer_push_primitive_clip
cogl_framebuffer_pop_clip
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
<SUBSECTION>
cogl_get_draw_framebuffer
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_set_framebuffer
cogl_push_framebuffer
cogl_pop_framebuffer
</SECTION>
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
<SECTION>
<FILE>cogl-onscreen</FILE>
<TITLE>CoglOnscreen: The Onscreen Framebuffer Interface</TITLE>
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
<SUBSECTION>
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
CoglOnscreen
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
cogl_is_onscreen
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
COGL_ONSCREEN
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
<SUBSECTION>
docs: update cogl-context 2.0 docs This fixes the 2.0 reference manual Makefile to not ignore cogl-context.h; it also adds cogl_context_new to cogl-sections.txt and removes cogl_begin/end_gl. (For using raw GL with Cogl 2.0 the plan was to add some API for creating additional GL contexts via some Cogl API and a way to push/pop those contexts.) Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-07-01 01:02:23 +00:00
cogl_onscreen_new
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
<SUBSECTION>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglOnscreenX11MaskCallback
onscreen: make platform specific onscreen apis consistent There were several CoglOnscreen functions named like: cogl_onscreen_<platform>_blah instead of cogl_<platform>_onscreen_blah so this patch updates those to be consistent with other platform specific apis we have in cogl. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-07-01 00:58:38 +00:00
cogl_x11_onscreen_set_foreign_window_xid
cogl_x11_onscreen_get_window_xid
cogl_x11_onscreen_get_visual_xid
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
<SUBSECTION>
onscreen: make platform specific onscreen apis consistent There were several CoglOnscreen functions named like: cogl_onscreen_<platform>_blah instead of cogl_<platform>_onscreen_blah so this patch updates those to be consistent with other platform specific apis we have in cogl. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-07-01 00:58:38 +00:00
cogl_win32_onscreen_set_foreign_window
cogl_win32_onscreen_get_window
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
<SUBSECTION>
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
cogl_onscreen_show
cogl_onscreen_hide
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
doc: Add _add/remove_frame_callback api to -sections.txt This lists the cogl_onscreen_add/remove_frame_callback functions and CoglFrameClosure and CoglFrameCallback types in cogl2-sections.txt (cherry picked from commit 6655fee97fb6bcc2a516b710cc8ca1179685cb8f)
2013-01-31 12:59:08 +00:00
<SUBSECTION>
CoglFrameCallback
CoglFrameClosure
cogl_onscreen_add_frame_callback
cogl_onscreen_remove_frame_callback
Add a callback to get dirty events from a CoglOnscreen This adds a callback that can be registered with cogl_onscreen_add_dirty_callback which will get called whenever the window system determines that the contents of the window is dirty and needs to be redrawn. Under the two X-based winsys's, this is reported off the back of the Expose events, under SDL it is reported from SDL_VIDEOEXPOSE or SDL_WINDOWEVENT_EXPOSED and under Windows from the WM_PAINT messages. The Wayland winsys doesn't really have the concept of dirtying the buffer but in order to allow applications to work the same way on all platforms it will emit the event when the surface is first shown and whenever it is resized. There is a private feature flag to specify whether dirty events are supported. If the winsys does not set this then Cogl will simulate dirty events by emitting one when the window is first allocated and when it is resized. The only winsys's that don't set this flag are things like KMS or the EGL null winsys where there is no windowing system and showing and hiding the onscreen doesn't really make any sense. In that case Cogl can assume the buffer will only become dirty once when it is first allocated. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 85c5a9ba419b2247bd768284c79ee69164a0c098) Conflicts: cogl/cogl-private.h
2013-05-14 12:39:48 +00:00
<SUBSECTION>
CoglOnscreenDirtyInfo
CoglOnscreenDirtyCallback
CoglOnscreenDirtyClosure
cogl_onscreen_add_dirty_callback
cogl_onscreen_remove_dirty_callback
onscreen: Make the resize callback work the same as the frame callback When adding the frame callback API in 70040166 we decided on a common idiom for adding callbacks which would return an opaque pointer representing the closure for the callback. This pointer can then be used to later remove the callback. The closure can also contain an optional callback to invoke when the user data parameter is destroyed. The resize callback didn't work this way and instead had an integer handle to identify the closure. This patch changes it to work the same way as the frame callback. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 33164c4b04d253ebe0ff41b12c1e90232c519274)
2013-04-04 19:25:42 +00:00
<SUBSECTION>
CoglOnscreenResizeCallback
CoglOnscreenResizeClosure
cogl_onscreen_add_resize_callback
cogl_onscreen_remove_resize_callback
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
<SUBSECTION>
cogl_onscreen_swap_buffers
onscreen: Adds swap_buffers_with_damage api This adds api to be able requests a swap_buffers and also pass a list of damage rectangles that can be passed on to a compositor to enable it to minimize how much of the screen it needs to recompose. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit 0d9684c7b7c2018bb42715c369555330d38514a2)
2012-02-07 17:59:51 +00:00
cogl_onscreen_swap_buffers_with_damage
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
cogl_onscreen_swap_region
cogl_onscreen_set_swap_throttled
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglSwapBuffersNotify
doc: The swap functions have moved from the framebuffer to the onscreen At the same time reorganise the Onscreen sections. (cherry picked from commit 5ef71e17f7b9f2b254cc33e2f574a8a3a5cfb09d)
2012-12-30 19:37:03 +00:00
cogl_onscreen_add_swap_buffers_callback
cogl_onscreen_remove_swap_buffers_callback
docs: Adds missing cogl_framebuffer syms to reference This adds a description for the cogl-framebuffer section and adds lots of missing symbols to the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 22:13:35 +00:00
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-offscreen</FILE>
<TITLE>Offscreen Framebuffers</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
CoglOffscreen
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_is_offscreen
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
<SUBSECTION>
cogl_offscreen_new_to_texture
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
<SECTION>
<FILE>cogl-color</FILE>
<TITLE>Color Type</TITLE>
CoglColor
cogl_color_new
cogl_color_copy
cogl_color_free
cogl_color_set_from_4ub
cogl_color_set_from_4f
<SUBSECTION>
cogl_color_get_red
cogl_color_get_green
cogl_color_get_blue
cogl_color_get_alpha
<SUBSECTION>
cogl_color_get_red_byte
cogl_color_get_green_byte
cogl_color_get_blue_byte
cogl_color_get_alpha_byte
<SUBSECTION>
cogl_color_get_red_float
cogl_color_get_green_float
cogl_color_get_blue_float
cogl_color_get_alpha_float
<SUBSECTION>
cogl_color_set_red
cogl_color_set_green
cogl_color_set_blue
cogl_color_set_alpha
<SUBSECTION>
cogl_color_set_red_byte
cogl_color_set_green_byte
cogl_color_set_blue_byte
cogl_color_set_alpha_byte
<SUBSECTION>
cogl_color_set_red_float
cogl_color_set_green_float
cogl_color_set_blue_float
cogl_color_set_alpha_float
<SUBSECTION>
cogl_color_premultiply
cogl_color_unpremultiply
cogl_color_equal
color: Add HSL conversion functions This allows to easily caculate shades of the same color or pick colors with the same saturation/luminance. In short, all sorts of interesting things. Reviewed-by: Robert Bragg <robert@linux.intel.com> Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit edcbeaf3c941f7a2335fbec47d5248cd9b0e8088)
2013-05-13 12:24:21 +00:00
<SUBSECTION>
cogl_color_init_from_hsl
cogl_color_to_hsl
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
<SECTION>
<FILE>cogl-matrix</FILE>
<TITLE>Matrices</TITLE>
CoglMatrix
cogl_matrix_init_identity
doc: Adds missing cogl_matrix syms to 2.0 reference There were a few cogl_matrix symbols missing from the cogl-sections.txt for the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 21:20:11 +00:00
cogl_matrix_init_from_array
matrix: Add a init_translation() constructor This allows people to initialize a matrix with a translation transformation. The options to do it at the moment were: * init_from_array() but it give cogl no information about the type of matrix. * init_indentity() and then translate() but it means doing a lot of computations for no reason. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 068b3b59221e405dc288d434b0008464684a7c12)
2012-05-03 11:26:11 +00:00
cogl_matrix_init_translation
Add a cogl_matrix_init_from_euler function This creates a matrix to represent the given euler rotation. This should be more efficient than creating the matrix by doing three separate rotations because no separate intermediate matrices are created and no matrix multiplication is needed. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit e66d9965897999a4889063f6df9a20ea6abf97fe)
2012-05-17 18:18:58 +00:00
cogl_matrix_init_from_quaternion
cogl_matrix_init_from_euler
doc: Adds missing cogl_matrix syms to 2.0 reference There were a few cogl_matrix symbols missing from the cogl-sections.txt for the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 21:20:11 +00:00
cogl_matrix_copy
cogl_matrix_equal
cogl_matrix_free
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_matrix_frustum
matrix: Add cogl_matrix_orthographic This adds an experimental cogl_matrix_orthographic() function that is more consistent with other Cogl api by taking x_1, y_1, x_2, y_2 arguments to define the top-left and bottom-right coordinates of the orthographic coordinates instead of OpenGL style left, right, bottom and top values. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-11-18 14:07:17 +00:00
cogl_matrix_orthographic
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_matrix_perspective
matrix: Add cogl_matrix_look_at Similar to the widely used gluLookAt API, this adds a CoglMatrix utility for setting up a view transform in terms of positioning a camera/eye position that points to a given object position aligned to a given world-up vector. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-07-09 01:43:17 +00:00
cogl_matrix_look_at
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_matrix_multiply
cogl_matrix_rotate
Add functions to directly transform from a euler or a quaternion This adds the following new functions to apply a rotation described by a euler or a quaternion to either a CoglMatrix or directly to the modelview stack of a framebuffer: cogl_matrix_rotate_quaternion cogl_matrix_rotate_euler cogl_framebuffer_rotate_quaternion cogl_framebuffer_rotate_euler The direct framebuffer functions have corresponding functions in the CoglMatrixStack to store an entry describing the rotation. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 5064315678b496395e1d01f266f322d73e55e324)
2012-05-17 21:22:01 +00:00
cogl_matrix_rotate_quaternion
cogl_matrix_rotate_euler
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_matrix_translate
cogl_matrix_scale
cogl-matrix: Add a public cogl_matrix_transpose() This function takes a single matrix argument and replaces the matrix with its transpose. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-11-03 15:31:46 +00:00
cogl_matrix_transpose
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_matrix_get_array
cogl_matrix_get_inverse
doc: Adds missing cogl_matrix syms to 2.0 reference There were a few cogl_matrix symbols missing from the cogl-sections.txt for the 2.0 reference manual. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 21:20:11 +00:00
cogl_matrix_transform_point
cogl_matrix_transform_points
cogl_matrix_project_points
matrix: Adds cogl_matrix_is_identity API This adds a function called cogl_matrix_is_identity that can determine if a given matrix is an identity matrix or not. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-30 21:15:08 +00:00
cogl_matrix_is_identity
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
matrix-stack: make CoglMatrixStack public We have found several times now when writing code using Cogl that it would really help if Cogl's matrix stack api was public as a utility api. In Rig for example we want to avoid redundant arithmetic when deriving the matrices of entities used to render and we aren't able to simply use the framebuffer's matrix stack to achieve this. Also when implementing cairo-cogl we found that it would be really useful if we could have a matrix stack utility api. (cherry picked from commit d17a01fd935d88fab96fe6cc0b906c84026c0067)
2012-11-20 17:08:43 +00:00
<SECTION>
<FILE>cogl-matrix-stack</FILE>
<TITLE>Matrix Stacks</TITLE>
CoglMatrixStack
CoglMatrixEntry
cogl_matrix_stack_new
cogl_matrix_stack_push
cogl_matrix_stack_pop
cogl_matrix_stack_load_identity
cogl_matrix_stack_scale
cogl_matrix_stack_translate
cogl_matrix_stack_rotate
cogl_matrix_stack_rotate_quaternion
cogl_matrix_stack_rotate_euler
cogl_matrix_stack_multiply
cogl_matrix_stack_frustum
cogl_matrix_stack_perspective
cogl_matrix_stack_orthographic
cogl_matrix_stack_get_inverse
cogl_matrix_stack_get_entry
cogl_matrix_stack_get
cogl_matrix_entry_get
cogl_matrix_stack_set
cogl_matrix_entry_calculate_translation
cogl_matrix_entry_is_identity
cogl_matrix_entry_equal
cogl_matrix_entry_ref
cogl_matrix_entry_unref
</SECTION>
doc: Include the documentation for CoglEuler Several little changes were needed to make the CoglEuler documentation appear: • Fix the embeded docbook snippet in the CoglEuler section header • Add the xinclude directive to the main document • Add the missing <SECTION> in -sections.txt Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit c7f6e07f7b8ba0d7dc9604e888c8a46165ec3ed4)
2012-05-11 10:57:03 +00:00
<SECTION>
math: Adds an experimental euler API This adds an experimental CoglEuler data type and the following new functions: cogl_euler_init cogl_euler_init_from_matrix cogl_euler_init_from_quaternion cogl_euler_equal cogl_euler_copy cogl_euler_free cogl_quaternion_init_from_euler Since this is experimental API you need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h
2010-02-25 01:40:29 +00:00
<FILE>cogl-euler</FILE>
<TITLE>Eulers (Rotations)</TITLE>
CoglEuler
cogl_euler_init
cogl_euler_init_from_matrix
cogl_euler_init_from_quaternion
cogl_euler_equal
cogl_euler_copy
cogl_euler_free
</SECTION>
math: Adds an experimental quaternion API This adds an experimental quaternion utility API. It's not yet fully documented but it's complete enough that people can start to experiment with using it. It adds the following functions: cogl_quaternion_init_identity cogl_quaternion_init cogl_quaternion_init_from_angle_vector cogl_quaternion_init_from_array cogl_quaternion_init_from_x_rotation cogl_quaternion_init_from_y_rotation cogl_quaternion_init_from_z_rotation cogl_quaternion_equal cogl_quaternion_copy cogl_quaternion_free cogl_quaternion_get_rotation_angle cogl_quaternion_get_rotation_axis cogl_quaternion_normalize cogl_quaternion_dot_product cogl_quaternion_invert cogl_quaternion_multiply cogl_quaternion_pow cogl_quaternion_slerp cogl_quaternion_nlerp cogl_quaternion_squad cogl_get_static_identity_quaternion cogl_get_static_zero_quaternion Since it's experimental API you'll need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h.
2010-02-25 01:40:29 +00:00
<SECTION>
<FILE>cogl-quaternion</FILE>
<TITLE>Quaternions (Rotations)</TITLE>
CoglQuaternion
cogl_quaternion_init_identity
cogl_quaternion_init
quaternion: Document init_from_quaternion() Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 91c2a3580a6055fcb6902524d3e8354f27932e89)
2012-05-11 10:43:35 +00:00
cogl_quaternion_init_from_quaternion
math: Adds an experimental quaternion API This adds an experimental quaternion utility API. It's not yet fully documented but it's complete enough that people can start to experiment with using it. It adds the following functions: cogl_quaternion_init_identity cogl_quaternion_init cogl_quaternion_init_from_angle_vector cogl_quaternion_init_from_array cogl_quaternion_init_from_x_rotation cogl_quaternion_init_from_y_rotation cogl_quaternion_init_from_z_rotation cogl_quaternion_equal cogl_quaternion_copy cogl_quaternion_free cogl_quaternion_get_rotation_angle cogl_quaternion_get_rotation_axis cogl_quaternion_normalize cogl_quaternion_dot_product cogl_quaternion_invert cogl_quaternion_multiply cogl_quaternion_pow cogl_quaternion_slerp cogl_quaternion_nlerp cogl_quaternion_squad cogl_get_static_identity_quaternion cogl_get_static_zero_quaternion Since it's experimental API you'll need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h.
2010-02-25 01:40:29 +00:00
cogl_quaternion_init_from_angle_vector
cogl_quaternion_init_from_array
cogl_quaternion_init_from_x_rotation
cogl_quaternion_init_from_y_rotation
cogl_quaternion_init_from_z_rotation
quaternion: Document init_from_euler() Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 018703a8e83835e7ab522f5e011fdd4a039523a2)
2012-05-11 10:40:38 +00:00
cogl_quaternion_init_from_euler
math: Adds an experimental quaternion API This adds an experimental quaternion utility API. It's not yet fully documented but it's complete enough that people can start to experiment with using it. It adds the following functions: cogl_quaternion_init_identity cogl_quaternion_init cogl_quaternion_init_from_angle_vector cogl_quaternion_init_from_array cogl_quaternion_init_from_x_rotation cogl_quaternion_init_from_y_rotation cogl_quaternion_init_from_z_rotation cogl_quaternion_equal cogl_quaternion_copy cogl_quaternion_free cogl_quaternion_get_rotation_angle cogl_quaternion_get_rotation_axis cogl_quaternion_normalize cogl_quaternion_dot_product cogl_quaternion_invert cogl_quaternion_multiply cogl_quaternion_pow cogl_quaternion_slerp cogl_quaternion_nlerp cogl_quaternion_squad cogl_get_static_identity_quaternion cogl_get_static_zero_quaternion Since it's experimental API you'll need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h.
2010-02-25 01:40:29 +00:00
cogl_quaternion_equal
cogl_quaternion_copy
cogl_quaternion_free
cogl_quaternion_get_rotation_angle
cogl_quaternion_get_rotation_axis
cogl_quaternion_normalize
cogl_quaternion_dot_product
cogl_quaternion_invert
cogl_quaternion_multiply
cogl_quaternion_pow
cogl_quaternion_slerp
cogl_quaternion_nlerp
cogl_quaternion_squad
cogl_get_static_identity_quaternion
cogl_get_static_zero_quaternion
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-pipeline</FILE>
<TITLE>Pipeline</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglPipeline
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_new
cogl_pipeline_copy
cogl_is_pipeline
cogl_pipeline_set_color
cogl_pipeline_set_color4ub
cogl_pipeline_set_color4f
cogl_pipeline_get_color
cogl_pipeline_set_ambient
cogl_pipeline_get_ambient
cogl_pipeline_set_diffuse
cogl_pipeline_get_diffuse
cogl_pipeline_set_ambient_and_diffuse
cogl_pipeline_set_emission
cogl_pipeline_get_emission
cogl_pipeline_set_specular
cogl_pipeline_get_specular
cogl_pipeline_set_shininess
cogl_pipeline_get_shininess
doc: Rename the remaining CoglMaterial* elements in the sections file (cherry picked from commit af775c8c3b3c1848ed07d33eaa2957abcd46797f)
2012-12-30 20:06:21 +00:00
CoglPipelineAlphaFunc
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_set_alpha_test_function
COGL_BLEND_STRING_ERROR
CoglBlendStringError
cogl_pipeline_set_blend
cogl_pipeline_set_blend_constant
cogl_pipeline_set_point_size
cogl_pipeline_get_point_size
Add support for per-vertex point sizes This adds a new function to enable per-vertex point size on a pipeline. This can be set with cogl_pipeline_set_per_vertex_point_size(). Once enabled the point size can be set either by drawing with an attribute named 'cogl_point_size_in' or by writing to the 'cogl_point_size_out' builtin from a snippet. There is a feature flag which must be checked for before using per-vertex point sizes. This will only be set on GL >= 2.0 or on GLES 2.0. GL will only let you set a per-vertex point size from GLSL by writing to gl_PointSize. This is only available in GL2 and not in the older GLSL extensions. The per-vertex point size has its own pipeline state flag so that it can be part of the state that affects vertex shader generation. Having to enable the per vertex point size with a separate function is a bit awkward. Ideally it would work like the color attribute where you can just set it for every vertex in your primitive with cogl_pipeline_set_color or set it per-vertex by just using the attribute. This is harder to get working with the point size because we need to generate a different vertex shader depending on what attributes are bound. I think if we wanted to make this work transparently we would still want to internally have a pipeline property describing whether the shader was generated with per-vertex support so that it would work with the shader cache correctly. Potentially we could make the per-vertex property internal and automatically make a weak pipeline whenever the attribute is bound. However we would then also need to automatically detect when an application is writing to cogl_point_size_out from a snippet. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 8495d9c1c15ce389885a9356d965eabd97758115) Conflicts: cogl/cogl-context.c cogl/cogl-pipeline-private.h cogl/cogl-pipeline.c cogl/cogl-private.h cogl/driver/gl/cogl-pipeline-progend-fixed.c cogl/driver/gl/gl/cogl-pipeline-progend-fixed-arbfp.c
2012-11-08 16:56:02 +00:00
cogl_pipeline_set_per_vertex_point_size
cogl_pipeline_get_per_vertex_point_size
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
Adds ColorMask support to Cogl This adds CoglPipeline and CoglFramebuffer support for setting a color mask which is a bit mask defining which color channels should be written to the current framebuffer. The final color mask is the intersection of the framebuffer color mask and the pipeline color mask. The framebuffer mask affects all rendering to the framebuffer while the pipeline masks can be used to affect individual primitives. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2011-07-11 01:27:54 +00:00
cogl_pipeline_get_color_mask
cogl_pipeline_set_color_mask
doc: Fix the remaining warning around the depth state Various changes have led to the current, separate from the pipeline, depth state, this commit fixes the remaining waring around that. (cherry picked from commit 111e687e722ad67a0e1c09f881c6282ccb06410b)
2012-12-31 14:58:31 +00:00
cogl_pipeline_set_depth_state
cogl_pipeline_get_depth_state
pipeline: Make the backface culling experimental public This adds two new experimental public functions to replace the old internal _cogl_pipeline_set_cull_face_state function: void cogl_pipeline_set_cull_face_mode (CoglPipeline *pipeline, CoglPipelineCullFaceMode cull_face_mode); void cogl_pipeline_set_front_face_winding (CoglPipeline *pipeline, CoglWinding front_winding); There are also the corresponding getters. https://bugzilla.gnome.org/show_bug.cgi?id=663628 Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-11-08 13:58:33 +00:00
CoglPipelineCullFaceMode
cogl_pipeline_set_cull_face_mode
CoglWinding
cogl_pipeline_set_front_face_winding
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_set_layer_texture
Add cogl_pipeline_set_layer_null_texture() This adds a public function to replace the texture for a layer with the default white texture. It is equivalent to calling cogl_pipeline_set_layer_texture with NULL for the texture object except that it also lets you choose a type for the texture. The idea is that applications using a base pipeline to make multiple copies that can share the generated shaders can use this function to make the layer come into existence with the right texture type. Previously the idiom would be to create a 1x1 dummy texture of the right type but this ends up creating lots of redundant little textures. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-02-09 13:59:52 +00:00
cogl_pipeline_set_layer_null_texture
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_get_layer_texture
doc: Rename the remaining CoglMaterial* elements in the sections file (cherry picked from commit af775c8c3b3c1848ed07d33eaa2957abcd46797f)
2012-12-30 20:06:21 +00:00
CoglPipelineFilter
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_set_layer_filters
cogl_pipeline_get_layer_min_filter
cogl_pipeline_get_layer_mag_filter
doc: Rename the remaining CoglMaterial* elements in the sections file (cherry picked from commit af775c8c3b3c1848ed07d33eaa2957abcd46797f)
2012-12-30 20:06:21 +00:00
CoglPipelineWrapMode
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_set_layer_wrap_mode
cogl_pipeline_set_layer_wrap_mode_s
cogl_pipeline_set_layer_wrap_mode_t
cogl_pipeline_set_layer_wrap_mode_p
cogl_pipeline_set_layer_combine
cogl_pipeline_set_layer_combine_constant
cogl_pipeline_set_layer_matrix
cogl_pipeline_set_layer_point_sprite_coords_enabled
cogl_pipeline_get_layer_point_sprite_coords_enabled
cogl_pipeline_remove_layer
cogl_pipeline_get_n_layers
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglPipelineLayerCallback
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pipeline_foreach_layer
cogl-pipeline: Add support for setting uniform values This adds the following new public experimental functions to set uniform values on a CoglPipeline: void cogl_pipeline_set_uniform_1f (CoglPipeline *pipeline, int uniform_location, float value); void cogl_pipeline_set_uniform_1i (CoglPipeline *pipeline, int uniform_location, int value); void cogl_pipeline_set_uniform_float (CoglPipeline *pipeline, int uniform_location, int n_components, int count, const float *value); void cogl_pipeline_set_uniform_int (CoglPipeline *pipeline, int uniform_location, int n_components, int count, const int *value); void cogl_pipeline_set_uniform_matrix (CoglPipeline *pipeline, int uniform_location, int dimensions, int count, gboolean transpose, const float *value); These are similar to the old functions used to set uniforms on a CoglProgram. To get a value to pass in as the uniform_location there is also: int cogl_pipeline_get_uniform_location (CoglPipeline *pipeline, const char *uniform_name); Conceptually the uniform locations are tied to the pipeline so that whenever setting a value for a new pipeline the application is expected to call this function. However in practice the uniform locations are global to the CoglContext. The names are stored in a linked list where the position in the list is the uniform location. The global indices are used so that each pipeline can store a mask of which uniforms it overrides. That way it is quicker to detect which uniforms are different from the last pipeline that used the same CoglProgramState so it can avoid flushing uniforms that haven't changed. Currently the values are not actually compared which means that it will only avoid flushing a uniform if there is a common ancestor that sets the value (or if the same pipeline is being flushed again - in which case the pipeline and its common ancestor are the same thing). The uniform values are stored in the big state of the pipeline as a sparse linked list. A bitmask stores which values have been overridden and only overridden values are stored in the linked list. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-11-03 17:20:43 +00:00
cogl_pipeline_get_uniform_location
cogl_pipeline_set_uniform_1f
cogl_pipeline_set_uniform_1i
cogl_pipeline_set_uniform_float
cogl_pipeline_set_uniform_int
cogl_pipeline_set_uniform_matrix
snippet: Add some more documentation This adds a documentation section for CoglSnippet which gives an overview of how to use them. It also fixes some syntax errors in the existing documentation and adds the missing pipeline functions for adding snippets to the documentation sections file. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-06 19:17:03 +00:00
cogl_pipeline_add_snippet
cogl_pipeline_add_layer_snippet
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SUBSECTION Private>
cogl_blend_string_error_get_type
Adds CoglError api Although we use GLib internally in Cogl we would rather not leak GLib api through Cogl's own api, except through explicitly namespaced cogl_glib_ / cogl_gtype_ feature apis. One of the benefits we see to not leaking GLib through Cogl's public API is that documentation for Cogl won't need to first introduce the Glib API to newcomers, thus hopefully lowering the barrier to learning Cogl. This patch provides a Cogl specific typedef for reporting runtime errors which by no coincidence matches the typedef for GError exactly. If Cogl is built with --enable-glib (default) then developers can even safely assume that a CoglError is a GError under the hood. This patch also enforces a consistent policy for when NULL is passed as an error argument and an error is thrown. In this case we log the error and abort the application, instead of silently ignoring it. In common cases where nothing has been implemented to handle a particular error and/or where applications are just printing the error and aborting themselves then this saves some typing. This also seems more consistent with language based exceptions which usually cause a program to abort if they are not explicitly caught (which passing a non-NULL error signifies in this case) Since this policy for NULL error pointers is stricter than the standard GError convention, there is a clear note in the documentation to warn developers that are used to using the GError api. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit b068d5ea09ab32c37e8c965fc8582c85d1b2db46) Note: Since we can't change the Cogl 1.x api the patch was changed to not rename _error_quark() functions to be _error_domain() functions and although it's a bit ugly, instead of providing our own CoglError type that's compatible with GError we simply #define CoglError to GError unless Cogl is built with glib disabled. Note: this patch does technically introduce an API break since it drops the cogl_error_get_type() symbol generated by glib-mkenum (Since the CoglError enum was replaced by a CoglSystemError enum) but for now we are assuming that this will not affect anyone currently using the Cogl API. If this does turn out to be a problem in practice then we would be able to fix this my manually copying an implementation of cogl_error_get_type() generated by glib-mkenum into a compatibility source file and we could also define the original COGL_ERROR_ enums for compatibility too. Note: another minor concern with cherry-picking this patch to the 1.14 branch is that an api scanner would be lead to believe that some APIs have changed, and for example the gobject-introspection parser which understands the semantics of GError will not understand the semantics of CoglError. We expect most people that have tried to use gobject-introspection with Cogl already understand though that it is not well suited to generating bindings of the Cogl api anyway and we aren't aware or anyone depending on such bindings for apis involving GErrors. (GnomeShell only makes very-very minimal use of Cogl via the gjs bindings for the cogl_rectangle and cogl_color apis.) The main reason we have cherry-picked this patch to the 1.14 branch even given the above concerns is that without it it would become very awkward for us to cherry-pick other beneficial patches from master.
2012-08-31 18:28:27 +00:00
cogl_blend_string_error_domain
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
</SECTION>
Add CoglDepthState API Instead of simply extending the cogl_pipeline_ namespace to add api for controlling the depth testing state we now break the api out. This adds a CoglDepthState type that can be stack allocated. The members of the structure are private but we have the following API to setup the state: cogl_depth_state_init cogl_depth_state_set_test_enabled cogl_depth_state_get_test_enabled cogl_depth_state_set_test_function cogl_depth_state_get_test_function cogl_depth_state_set_writing_enabled cogl_depth_state_get_writing_enabled cogl_depth_state_set_range cogl_depth_state_get_range This removes the following experimental API which is now superseded: cogl_material_set_depth_test_enabled cogl_material_get_depth_test_enabled cogl_material_set_depth_test_function cogl_material_get_depth_test_function cogl_material_set_depth_writing_enabled cogl_material_get_depth_writing_enabled cogl_material_set_depth_range cogl_material_get_depth_range Once a CoglDepthState structure is setup it can be set on a pipeline using cogl_pipeline_set_depth_state().
2011-04-14 17:12:03 +00:00
<SECTION>
<FILE>cogl-depth-state</FILE>
doc: Expose CoglDepthState It wasn't included to the documention up to now. (cherry picked from commit 826c0d5c8333ad31595d690d7c8753f84d12b2ad)
2012-12-30 20:21:34 +00:00
<TITLE>Depth State</TITLE>
Add CoglDepthState API Instead of simply extending the cogl_pipeline_ namespace to add api for controlling the depth testing state we now break the api out. This adds a CoglDepthState type that can be stack allocated. The members of the structure are private but we have the following API to setup the state: cogl_depth_state_init cogl_depth_state_set_test_enabled cogl_depth_state_get_test_enabled cogl_depth_state_set_test_function cogl_depth_state_get_test_function cogl_depth_state_set_writing_enabled cogl_depth_state_get_writing_enabled cogl_depth_state_set_range cogl_depth_state_get_range This removes the following experimental API which is now superseded: cogl_material_set_depth_test_enabled cogl_material_get_depth_test_enabled cogl_material_set_depth_test_function cogl_material_get_depth_test_function cogl_material_set_depth_writing_enabled cogl_material_get_depth_writing_enabled cogl_material_set_depth_range cogl_material_get_depth_range Once a CoglDepthState structure is setup it can be set on a pipeline using cogl_pipeline_set_depth_state().
2011-04-14 17:12:03 +00:00
CoglDepthState
doc: Fix the remaining warning around the depth state Various changes have led to the current, separate from the pipeline, depth state, this commit fixes the remaining waring around that. (cherry picked from commit 111e687e722ad67a0e1c09f881c6282ccb06410b)
2012-12-31 14:58:31 +00:00
CoglDepthTestFunction
Add CoglDepthState API Instead of simply extending the cogl_pipeline_ namespace to add api for controlling the depth testing state we now break the api out. This adds a CoglDepthState type that can be stack allocated. The members of the structure are private but we have the following API to setup the state: cogl_depth_state_init cogl_depth_state_set_test_enabled cogl_depth_state_get_test_enabled cogl_depth_state_set_test_function cogl_depth_state_get_test_function cogl_depth_state_set_writing_enabled cogl_depth_state_get_writing_enabled cogl_depth_state_set_range cogl_depth_state_get_range This removes the following experimental API which is now superseded: cogl_material_set_depth_test_enabled cogl_material_get_depth_test_enabled cogl_material_set_depth_test_function cogl_material_get_depth_test_function cogl_material_set_depth_writing_enabled cogl_material_get_depth_writing_enabled cogl_material_set_depth_range cogl_material_get_depth_range Once a CoglDepthState structure is setup it can be set on a pipeline using cogl_pipeline_set_depth_state().
2011-04-14 17:12:03 +00:00
cogl_depth_state_init
cogl_depth_state_set_test_enabled
cogl_depth_state_get_test_enabled
cogl_depth_state_set_test_function
cogl_depth_state_get_test_function
doc: Expose CoglDepthState It wasn't included to the documention up to now. (cherry picked from commit 826c0d5c8333ad31595d690d7c8753f84d12b2ad)
2012-12-30 20:21:34 +00:00
cogl_depth_state_set_write_enabled
cogl_depth_state_get_write_enabled
Add CoglDepthState API Instead of simply extending the cogl_pipeline_ namespace to add api for controlling the depth testing state we now break the api out. This adds a CoglDepthState type that can be stack allocated. The members of the structure are private but we have the following API to setup the state: cogl_depth_state_init cogl_depth_state_set_test_enabled cogl_depth_state_get_test_enabled cogl_depth_state_set_test_function cogl_depth_state_get_test_function cogl_depth_state_set_writing_enabled cogl_depth_state_get_writing_enabled cogl_depth_state_set_range cogl_depth_state_get_range This removes the following experimental API which is now superseded: cogl_material_set_depth_test_enabled cogl_material_get_depth_test_enabled cogl_material_set_depth_test_function cogl_material_get_depth_test_function cogl_material_set_depth_writing_enabled cogl_material_get_depth_writing_enabled cogl_material_set_depth_range cogl_material_get_depth_range Once a CoglDepthState structure is setup it can be set on a pipeline using cogl_pipeline_set_depth_state().
2011-04-14 17:12:03 +00:00
cogl_depth_state_set_range
cogl_depth_state_get_range
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-buffer</FILE>
2.0 reference: make various fixups in cogl-sections.txt This does some minor gardening in cogl-sections.txt, tweaking some of the section titles and removing some stale api references. Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-27 10:19:15 +00:00
<TITLE>CoglBuffer: The Buffer Interface</TITLE>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglBuffer
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_is_buffer
cogl_buffer_get_size
CoglBufferUsageHint
cogl_buffer_set_usage_hint
cogl_buffer_get_usage_hint
CoglBufferUpdateHint
cogl_buffer_set_update_hint
cogl_buffer_get_update_hint
CoglBufferAccess
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglBufferMapHint
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_buffer_map
Add cogl_buffer_map_range() This adds a buffer method to map a subregion of the buffer. This works using the GL_ARB_map_buffer_range extension. If the extension is not available then it will fallback to using glMapBuffer to map the entire buffer and then just add the offset to the returned pointer. cogl_buffer_map() is now just a wrapper which maps the entire range of the buffer. The driver backend functions have been renamed to map_range and they now all take the offset and size arguments. When the COGL_BUFFER_MAP_HINT_DISCARD hint is used and the map range extension is available instead of using glBufferData to invalidate the buffer it will instead pass the new GL_MAP_HINT_INVALIDATE_BUFFER flag. There is now additionally a COGL_BUFFER_MAP_HINT_DISCARD_REGION hint which can be used if the application only wants to discard the small region that is mapped. glMapBufferRange is always used if it is available even if the entire buffer is being mapped because it seems more robust to pass those flags then to call glBufferData. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 55ca02b5ca9cafc750251ec974e0d6a536cb80b8)
2012-10-17 20:28:45 +00:00
cogl_buffer_map_range
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_buffer_unmap
cogl_buffer_set_data
<SUBSECTION>
doc: Fixup type references gtk-doc needs the types in -sections.txt to be able to do cross-references. Add all those currently generating warnings. (cherry picked from commit e57a21d2608f0885e6f2eb3a017feb7dffb7a63c)
2012-12-31 17:20:56 +00:00
CoglPixelBuffer
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
cogl_pixel_buffer_new
cogl_is_pixel_buffer
<SUBSECTION Private>
cogl_buffer_access_get_type
cogl_buffer_update_hint_get_type
cogl_buffer_usage_hint_get_type
</SECTION>
docs: Adds cogl-index/attribute-buffer syms to 2.0 reference Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 16:35:29 +00:00
<SECTION>
<FILE>cogl-attribute-buffer</FILE>
<TITLE>CoglAttributeBuffer: Buffers of vertex attributes</TITLE>
CoglAttributeBuffer
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.
2012-11-08 17:54:10 +00:00
cogl_attribute_buffer_new_with_size
docs: Adds cogl-index/attribute-buffer syms to 2.0 reference Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 16:35:29 +00:00
cogl_attribute_buffer_new
cogl_is_attribute_buffer
</SECTION>
<SECTION>
<FILE>cogl-index-buffer</FILE>
<TITLE>CoglIndexBuffer: Buffers of vertex indices</TITLE>
CoglIndexBuffer
cogl_index_buffer_new
cogl_is_index_buffer
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-vector</FILE>
<TITLE>3 Component Vectors</TITLE>
cogl_vector3_init
cogl_vector3_init_zero
cogl_vector3_equal
cogl_vector3_equal_with_epsilon
cogl_vector3_copy
cogl_vector3_free
cogl_vector3_invert
cogl_vector3_add
cogl_vector3_subtract
cogl_vector3_multiply_scalar
cogl_vector3_divide_scalar
cogl_vector3_normalize
cogl_vector3_magnitude
cogl_vector3_cross_product
cogl_vector3_dot_product
cogl_vector3_distance
</SECTION>
Add fence API cogl_framebuffer_add_fence creates a synchronisation fence, which will invoke a user-specified callback when the GPU has finished executing all commands provided to it up to that point in time. Support is currently provided for GL 3.x's GL_ARB_sync extension, and EGL's EGL_KHR_fence_sync (when used with OpenGL ES). Signed-off-by: Daniel Stone <daniel@fooishbar.org> Reviewed-by: Neil Roberts <neil@linux.intel.com> Reviewed-by: Robert Bragg <robert@linux.intel.com> https://bugzilla.gnome.org/show_bug.cgi?id=691752 (cherry picked from commit e6d37470da9294adc1554c0a8c91aa2af560ed9f)
2013-01-11 01:13:34 +00:00
<SECTION>
<FILE>cogl-fence</FILE>
<TITLE>GPU synchronisation fences</TITLE>
CoglFence
CoglFenceCallback
CoglFenceClosure
cogl_fence_closure_get_user_data
cogl_framebuffer_add_fence_callback
cogl_framebuffer_cancel_fence_callback
</SECTION>
Add a cogl-version header This adds a version header which contains macros to define which version of Cogl the application is being compiled against. This helps applications that want to support multiple incompatible versions of Cogl at compile time. The macros are called COGL_VERSION_{MAJOR,MINOR,MICRO}. This does not match Clutter which names them CLUTTER_{MAJOR,MINOR,MICRO}_VERSION but I think the former is nicer and it at least matches Cairo and Pango. The values of the macro are defined to COGL_VERSION_*_INTERNAL which is generated by the configure script into cogl-defines.h. There is also a macro for the entire version as a string called COGL_VERSION_STRING. The internal utility macros for encoding a 3 part version number into a single integer have been moved into the new header so they can be used publicly as a convenient way to check if the version is within a particular range. There is also a COGL_VERSION_CHECK macro for the very common case that a feature will be used since a particular version of Cogl. There is a macro called COGL_VERSION which contains the pre-encoded version of Cogl being compiled against for convenience. Unlike in Clutter this patch does not add any runtime version identification mechanism. A test case is also added which just contains static asserts to sanity check the macros. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 3480cf140dc355fa87ab3fbcf0aeeb0124798a8f)
2012-04-23 13:09:19 +00:00
<SECTION>
<FILE>cogl-version</FILE>
<TITLE>Versioning utility macros</TITLE>
COGL_VERSION_MAJOR
COGL_VERSION_MINOR
COGL_VERSION_MICRO
COGL_VERSION_STRING
COGL_VERSION
COGL_VERSION_ENCODE
COGL_VERSION_CHECK
COGL_VERSION_GET_MAJOR
COGL_VERSION_GET_MINOR
COGL_VERSION_GET_MICRO
</SECTION>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 22:23:44 +00:00
<SECTION>
<FILE>cogl-gtype</FILE>
<TITLE>GType Integration API</TITLE>
cogl_gtype_matrix_get_type
</SECTION>
Rework sdl integration api This re-works the SDL integration api to simplify the integration for application developers and also allow Cogl to know when the application is about to go idle waiting for events so it can perform idle book-keeping work. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-04-06 10:16:19 +00:00
<SECTION>
Fix the inclusion of the SDL integration documentation You had a mismatch between the file name in -sections.txt and -docs.xml.in. Chose cogl-sdl.xml. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 8b61963f3015e11bd5fbe225ec566ac6e354acc1)
2012-05-28 13:43:58 +00:00
<FILE>cogl-sdl</FILE>
Rework sdl integration api This re-works the SDL integration api to simplify the integration for application developers and also allow Cogl to know when the application is about to go idle waiting for events so it can perform idle book-keeping work. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-04-06 10:16:19 +00:00
<TITLE>SDL Integration</TITLE>
cogl_sdl_context_new
cogl_sdl_renderer_set_event_type
cogl_sdl_renderer_get_event_type
cogl_sdl_handle_event
cogl_sdl_idle
Add cogl_sdl_onscreen_get_window() This adds a function to get a pointer to the SDL_Window associated with a CoglOnscreen when using the SDL2 winsys. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 071f4b80daa8a2f967746a30b3acf014d74f781a)
2012-11-26 13:07:36 +00:00
cogl_sdl_onscreen_get_window
Rework sdl integration api This re-works the SDL integration api to simplify the integration for application developers and also allow Cogl to know when the application is about to go idle waiting for events so it can perform idle book-keeping work. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-04-06 10:16:19 +00:00
</SECTION>
doc: Expose the Cogl GLES 2.0 facilities in the documentation (cherry picked from commit 0c2344b9aafe4afdf7782fd9badc451de79b7a63)
2012-12-30 15:14:34 +00:00
<SECTION>
<FILE>cogl-gles2</FILE>
<TITLE>GLES 2.0 context</TITLE>
<SUBSECTION>
CoglGLES2Context
CoglGLES2Vtable
COGL_GLES2_CONTEXT_ERROR
CoglGLES2ContextError
cogl_gles2_context_new
cogl_is_gles2_context
<SUBSECTION>
cogl_gles2_context_get_vtable
cogl_push_gles2_context
cogl_pop_gles2_context
cogl_gles2_get_current_vtable
<SUBSECTION>
cogl_gles2_texture_2d_new_from_handle
cogl_gles2_texture_get_handle
</SECTION>
Reference in New Issue Copy Permalink