Cogl – 10

Frame information.

A structure for holding a color definition. The contents of the CoglColor structure are private and should never by accessed directly.

This struct is used to pass information to the callback when cogl_debug_object_foreach_type() is called.

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

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().

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.

Used to specify vertex information when calling cogl_polygon()

A CoglUserDataKey is used to declare a key for attaching data to a CoglObject using cogl_object_set_user_data. The typedef only exists as a formality to make code self documenting since only the unique address of a CoglUserDataKey is used.

Integer representation of an angle such that 1024 corresponds to full circle (i.e., 2 * pi).

Type used for storing references to cogl objects, the CoglHandle is a fully opaque type without any public data members.

When associating private data with a CoglObject a callback can be given which will be called either if the object is destroyed or if cogl_object_set_user_data() is called with NULL user_data for the same key.

Data types for the components of a vertex attribute.

Error codes that can be thrown when performing bitmap operations. Note that gdk_pixbuf_new_from_file() can also throw errors directly from the underlying image loading library. For example, if GdkPixbuf is used then errors GdkPixbufErrors will be used directly.

Error enumeration for the blend strings parser.

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().

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.

Types of shaders.

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

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().

Types of auxiliary buffers.

Target flags for FBOs.

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.

Flags for cogl_framebuffer_read_pixels_into_bitmap()

Flags to pass to the cogl_texture_new_* family of functions.

A callback function to use for cogl_debug_object_foreach_type().

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

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

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.

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

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.

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

Invokes func once for each type of object that Cogl uses and passes a count of the number of objects for that type. This is intended to be used solely for debugging purposes to track down issues with objects leaking.

Prints a list of all the object types that Cogl uses along with the number of objects of that type that are currently in use. This is intended to be used solely for debugging purposes to track down issues with objects leaking.

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.

Retrieves the GOptionGroup used by Cogl to parse the command line options. Clutter uses this to handle the Cogl command line options during its initialization process.

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.

Checks if a given feature is currently available.

Checks if a list of features are all currently available.

Checks whether object is a CoglBitmap.

Gets whether the given object references an existing context object.

Gets whether the given object references a CoglFrameInfo.

Gets whether the given object references a CoglFramebuffer.

Gets whether the given object references an existing pipeline object.

Gets whether the given handle references an existing program object.

Gets whether the given handle references an existing shader object.

Gets whether the given object references a texture object.

Gets whether the given object references an existing CoglTexture2D object.

Gets whether the given object references a CoglTexture2DSliced.

Queries the number of bytes per pixel for a given format in the given plane.

Returns the number of planes the given CoglPixelFormat specifies.

Returns a string representation of format, useful for debugging purposes.

Attaches a shader to a program object. A program can have multiple vertex or fragment shaders but only one of them may provide a main() function. It is allowed to use a program with only a vertex shader or only a fragment shader.

Retrieve the location (offset) of a uniform variable in a shader program, a uniform is a variable that is constant for all vertices/fragments for a shader object and is possible to modify as an external parameter.

Links a program making it ready for use. Note that calling this function is optional. If it is not called the program will automatically be linked the first time it is used.

Changes the value of a floating point uniform for the given linked program.

Changes the value of an integer uniform for the given linked program.

Changes the value of a float vector uniform, or uniform array for the given linked program.

Changes the value of a int vector uniform, or uniform array for the given linked program.

Changes the value of a matrix uniform, or uniform array in the given linked program.

Retrieves the type of a shader CoglHandle.

Replaces the current source associated with a shader with a new one.

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.

Clears a reference to a CoglObject.

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