Cogl – 14

Functions for managing textures in Cogl’s global set of texture atlases.

Functions for creating and manipulating attribute buffers.

Functions for loading images.

Common buffer functions, including data upload APIs.

The top level application context.

Common aspects of a display pipeline.

Frame information.

Functions for creating and manipulating vertex indices.

Describe vertex indices stored in a CoglIndexBuffer.

Efficiently tracking many related transformations.

Functions for creating and manipulating offscreen framebuffers.

Information about an output device.

Functions for creating and manipulating the GPU pipeline.

Functions for creating, manipulating and drawing primitives.

Choosing a means to render.

Functions for accessing the programmable GL pipeline.

Functions for creating and manipulating shader snippets.

Functions for creating and manipulating sub-textures.

Functions for creating and manipulating textures.

Functions for creating and manipulating 2D textures.

Functions for creating and manipulating 2D meta textures that may internally be comprised of multiple 2D textures with power-of-two sizes.

A generic color definition.

Functions for describing the depth testing state of your GPU.

An opaque type that tracks the lifetime of a DMA buffer fd. Release with cogl_dma_buf_handle_free().

Functions for notification of command completion.

An opaque type representing one future callback to be made when the GPU command stream has passed a certain point.

An opaque type that tracks a CoglFrameCallback and associated user data. A CoglFrameClosure pointer will be returned from cogl_onscreen_add_frame_callback() and it allows you to remove a callback later using cogl_onscreen_remove_frame_callback().

Represents a single immutable transformation that was retrieved from a CoglMatrixStack using cogl_matrix_stack_get_entry().

An opaque type that tracks a CoglOnscreenDirtyCallback and associated user data. A CoglOnscreenDirtyClosure pointer will be returned from cogl_onscreen_add_dirty_callback() and it allows you to remove a callback later using cogl_onscreen_remove_dirty_callback().

A structure passed to callbacks registered using cogl_onscreen_add_dirty_callback(). The members describe a rectangle within the onscreen buffer that should be redrawn.

A struct for describing the state of a file descriptor that Cogl needs to block on. The events field contains a bitmask of CoglPollFDEvents that should cause the application to wake up. After the application is woken up from idle it should pass back an array of CoglPollFDs to Cogl and update the revents mask to the actual events that occurred on the file descriptor.

Used to specify vertex information when calling cogl_polygon()

A convenience vertex definition that can be used with cogl_primitive_new_p2().

A convenience vertex definition that can be used with cogl_primitive_new_p2c4().

A convenience vertex definition that can be used with cogl_primitive_new_p2t2().

A convenience vertex definition that can be used with cogl_primitive_new_p3t2c4().

A convenience vertex definition that can be used with cogl_primitive_new_p3().

A convenience vertex definition that can be used with cogl_primitive_new_p3c4().

A convenience vertex definition that can be used with cogl_primitive_new_p3t2().

A convenience vertex definition that can be used with cogl_primitive_new_p3t2c4().

Data types for the components of a vertex attribute.

Error codes that can be thrown when performing bitmap operations.

Error enumeration for the blend strings parser.

Error enumeration for CoglBuffer.

The update hint on a buffer allows the user to give some detail on how often the buffer data is going to be updated.

When using depth testing one of these functions is used to compare the depth of an incoming fragment against the depth value currently stored in the depth buffer. The function is changed using cogl_depth_state_set_test_function().

Identifiers for underlying hardware drivers that may be used by Cogl for rendering.

All the capabilities that can vary between different GPUs supported by Cogl. Applications that depend on any of these features should explicitly check for them using cogl_has_feature() or cogl_has_features().

Return values for the CoglXlibFilterFunc and CoglWin32FilterFunc functions.

Identifiers that are passed to CoglFrameCallback functions (registered using cogl_onscreen_add_frame_callback()) that mark the progression of a frame in some way which usually means that new information will have been accumulated in the frame’s corresponding CoglFrameInfo object.

All the error values that might be returned by cogl_get_graphics_reset_status(). Each value’s meaning corresponds to the similarly named value defined in the ARB_robustness and NV_robustness_video_memory_purge extensions.

You should aim to use the smallest data type that gives you enough range, since it reduces the size of your index array and can help reduce the demand on memory bandwidth.

Alpha testing happens before blending primitives with the framebuffer and gives an opportunity to discard fragments based on a comparison with the incoming alpha value and a reference alpha value. The CoglPipelineAlphaFunc determines how the comparison is done.

Specifies which faces should be culled. This can be set on a pipeline using cogl_pipeline_set_cull_face_mode().

Texture filtering is used whenever the current pixel maps either to more than one texture element (texel) or less than one. These filter enums correspond to different strategies used to come up with a pixel color, by possibly referring to multiple neighbouring texels and taking a weighted average or simply using the nearest texel.

The wrap mode specifies what happens when texture coordinates outside the range 0→1 are used. Note that if the filter mode is anything but COGL_PIPELINE_FILTER_NEAREST then texels outside the range 0→1 might be used even when the coordinate is exactly 0 or 1 because OpenGL will try to sample neighbouring pixels. For example if you are trying to render the full texture then you may get artifacts around the edges when the pixels from the other side are merged in if the wrap mode is set to repeat.

Pixel formats used by Cogl. For the formats with a byte per component, the order of the components specify the order in increasing memory addresses. So for example COGL_PIXEL_FORMAT_RGB_888 would have the red component in the lowest address, green in the next address and blue after that regardless of the endianness of the system.

A bitmask of events that Cogl may need to wake on for a file descriptor. Note that these all have the same values as the corresponding defines for the poll function call on Unix so they may be directly passed to poll.

Types of shaders.

CoglSnippetHook is used to specify a location within a CoglPipeline where the code of the snippet should be used when it is attached to a pipeline.

Represents how draw should affect the two buffers of a stereo framebuffer. See cogl_framebuffer_set_stereo_mode().

Some output devices (such as LCD panels) display colors by making each pixel consist of smaller “subpixels” that each have a particular color. By using knowledge of the layout of this subpixel components, it is possible to create image content with higher resolution than the pixel grid.

Error enumeration for Cogl.

See cogl_texture_set_components().

Error codes that can be thrown when allocating textures.

Different ways of interpreting vertices when drawing.

Enum used to represent the two directions of rotation. This can be used to set the front face for culling by calling cogl_pipeline_set_front_face_winding().

Identifies specific window system backends that Cogl supports.

The access hints for cogl_buffer_set_update_hint()

Types of auxiliary buffers.

Hints to Cogl about how you are planning to modify the data once it is mapped.

Target flags for FBOs.

Flags for cogl_framebuffer_read_pixels_into_bitmap()

These constraint flags are hard-coded features of the different renderer backends. Sometimes a platform may support multiple rendering options which Cogl will usually choose from automatically. Some of these features are important to higher level applications and frameworks though, such as whether a renderer is X11 based because an application might only support X11 based input handling. An application might also need to ensure EGL is used internally too if they depend on access to an EGLDisplay for some purpose.

A callback used with cogl_foreach_feature() for enumerating all context level features supported by Cogl.

The callback prototype used with cogl_framebuffer_add_fence_callback() for notification of GPU command completion.

Is a callback that can be registered via cogl_onscreen_add_frame_callback() to be called when a frame progresses in some notable way.

A callback used with cogl_meta_texture_foreach_in_region() to retrieve details of all the low-level CoglTextures that make up a given CoglMetaTexture.

Is a callback that can be registered via cogl_onscreen_add_dirty_callback() to be called when the windowing system determines that a region of the onscreen window has been lost and the application should redraw it.

A callback type that can be passed to cogl_renderer_foreach_output() for iterating display outputs for a given renderer.

The callback prototype used with cogl_pipeline_foreach_layer() for iterating all the layers of a pipeline.

The callback prototype used with cogl_primitive_foreach_attribute() for iterating all the attributes of a CoglPrimitive.

return FALSE for an immediately detected error, TRUE otherwise.

Create a new cogl program object that can be used to replace parts of the GL rendering pipeline with custom code.

deprecated: 1.16 

Create a new shader handle, use cogl_shader_source() to set the source code to be used on it.

deprecated: 1.16 

Allows visualizing the operations that build up the given entry for debugging purposes by printing to stdout.

This function should only need to be called in exceptional circumstances.

Iterates through all the context level features currently supported for a given context and for each feature callback is called.

Returns the graphics reset status as reported by GetGraphicsResetStatusARB defined in the ARB_robustness extension.

Gets a pointer to a given GL or GL ES extension function. This acts as a wrapper around glXGetProcAddress() or whatever is the appropriate function for the current backend.

Creates a GSource which handles Cogl’s internal system event processing. This can be used as a convenience instead of cogl_poll_renderer_get_info() and cogl_poll_renderer_dispatch() in applications that are already using the GLib main loop. After this is called the GSource should be attached to the main loop using g_source_attach().

Creates a GSource which handles Cogl’s internal system event processing. This can be used as a convenience instead of cogl_poll_renderer_get_info() and cogl_poll_renderer_dispatch() in applications that are already using the GLib main loop. After this is called the GSource should be attached to the main loop using g_source_attach().

Transforms a point whose position is given and returned as four float components.

Projects an array of input points and writes the result to another array of output points. The input points can either have 2, 3 or 4 components each. The output points always have 4 components (known as homogeneous coordinates). The output array can simply point to the input array to do the transform in-place.

Transforms an array of input points and writes the result to another array of output points. The input points can either have 2 or 3 components each. The output points always have 3 components. The output array can simply point to the input array to do the transform in-place.

Checks if a given feature is currently available.

Checks if a list of features are all currently available.

Gets whether the given object references a CoglFramebuffer.

Allows you to manually iterate the low-level textures that define a given region of a high-level CoglMetaTexture.

This should be called whenever an application is woken up from going idle in its main loop. The poll_fds array should contain a list of file descriptors matched with the events that occurred in revents. The events field is ignored. It is safe to pass in extra file descriptors that Cogl didn’t request when calling cogl_poll_renderer_get_info() or a shorter array missing some file descriptors that Cogl requested.

Is used to integrate Cogl with an application mainloop that is based on the unix poll(2) api (or select() or something equivalent). This api should be called whenever an application is about to go idle so that Cogl has a chance to describe what file descriptor events it needs to be woken up for.

Adds a callback function that will receive all native events. The function can stop further processing of the event by return COGL_FILTER_REMOVE.

This function processes a single event; it can be used to hook into external event retrieval (for example that done by Clutter or GDK).

Removes a callback that was previously added with cogl_xlib_renderer_add_filter().

Sets whether Cogl should make use of the NV_robustness_video_memory_purge extension, if exposed by the driver, by initializing the GLX context appropriately.

Sets a foreign Xlib display that Cogl will use for and Xlib based winsys backend.

The maximum number of planes of a pixel format (see also cogl_pixel_format_get_planes()).