Structs§
- Atlas
Texture - Atlas
Texture Class - Attribute
- Attribute
Buffer - Attribute
Buffer Class - Attribute
Class - Bitmap
- Bitmap
Class - Buffer
Access - Buffer
Bit - Buffer
MapHint - Buffer
Target - Color
- Color
Mask - Context
- Context
Class - Debug
Object Type Info - Depth
State - Display
- Display
Class - Euler
- Feature
Flags - Fence
- Fence
Closure - Fixed
- Fixed
Class - Frame
Closure - Frame
Info - Frame
Info Class - Framebuffer
- GLES2
Context - GLES2
Context Class - GLES2
Vtable - Gtype
Object - Handle
- Index
Buffer - Index
Buffer Class - Indices
- Indices
Class - KmsCrtc
- Material
- Material
Layer - Matrix
- Matrix
Entry - Matrix
Stack - Matrix
Stack Class - Object
- Object
Class - Offscreen
- Offscreen
Class - Onscreen
- Onscreen
Class - Onscreen
Dirty Closure - Onscreen
Dirty Info - Onscreen
Resize Closure - Onscreen
Template - Onscreen
Template Class - Output
- Output
Class - Pipeline
- Pipeline
Class - Pixel
Buffer - Pixel
Buffer Class - PollFD
- Primitive
- Primitive
Class - Quaternion
- Read
Pixels Flags - Renderer
- Renderer
Class - Renderer
Constraint - Snippet
- Snippet
Class - SubTexture
- SubTexture
Class - Swap
Chain - Swap
Chain Class - Texture
- Texture2D
- Texture2D
Class - Texture2D
Sliced - Texture2D
Sliced Class - Texture3D
- Texture3D
Class - Texture
Flags - Texture
Pixmap X11 - Texture
Pixmap X11Class - Texture
Rectangle - Texture
Rectangle Class - Texture
Vertex - User
Data Key - Vertex
P2 - Vertex
P3 - Vertex
P2C4 - Vertex
P2T2 - Vertex
P2T2 C4 - Vertex
P3C4 - Vertex
P3T2 - Vertex
P3T2 C4
Enums§
- Attribute
Type - Data types for the components of a vertex attribute.
- Bitmap
Error - 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, ifGdkPixbuf
is used then errorsGdkPixbufError
s will be used directly. - Blend
String Error - Error enumeration for the blend strings parser
- Buffer
Error - Error enumeration for
Buffer
- Buffer
Update Hint - The update hint on a buffer allows the user to give some detail on how often the buffer data is going to be updated.
- Depth
Test Function - 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
DepthState::set_test_function
. - Driver
- Identifiers for underlying hardware drivers that may be used by Cogl for rendering.
- FeatureID
- 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
orcogl_has_features
. - Filter
Return - Return values for the
CoglXlibFilterFunc
andCoglWin32FilterFunc
functions. - FogMode
- The fog mode determines the equation used to calculate the fogging blend
factor while fogging is enabled. The simplest
FogMode::Linear
mode determines f as: - Frame
Event - Identifiers that are passed to
CoglFrameCallback
functions (registered usingOnscreen::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 correspondingFrameInfo
object. - Framebuffer
Error - GLES2
Context Error - Error codes that relate to the cogl_gles2_context api.
- Indices
Type - 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.
- Material
Alpha Func - 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
MaterialAlphaFunc
determines how the comparison is done. - Material
Filter - 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.
- Material
Layer Type - Available types of layers for a
Material
. This enumeration might be expanded in later versions. - Material
Wrap Mode - 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
MaterialFilter::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. - Pipeline
Alpha Func - 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
PipelineAlphaFunc
determines how the comparison is done. - Pipeline
Cull Face Mode - Specifies which faces should be culled. This can be set on a
pipeline using
Pipeline::set_cull_face_mode
. - Pipeline
Filter - 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.
- Pipeline
Wrap Mode - 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
PipelineFilter::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
Format - 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
PixelFormat::Rgb888
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. - PollFD
Event - 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.
- Renderer
Error - Shader
Type - Types of shaders
- Snippet
Hook SnippetHook
is used to specify a location within aPipeline
where the code of the snippet should be used when it is attached to a pipeline.- Stereo
Mode - Represents how draw should affect the two buffers
of a stereo framebuffer. See
Framebuffer::set_stereo_mode
. - Subpixel
Order - 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.
- System
Error - Error enumeration for Cogl
- Texture
Components - See
Texture::set_components
. - Texture
Error - Error codes that can be thrown when allocating textures.
- Texture
Pixmap X11Error - Error codes that can be thrown when performing texture-pixmap-x11 operations.
- Texture
Pixmap X11Report Level - Texture
Type - Constants representing the underlying hardware texture type of a
Texture
. - Vertices
Mode - Different ways of interpreting vertices when drawing.
- Winding
- Enum used to represent the two directions of rotation. This can be
used to set the front face for culling by calling
Pipeline::set_front_face_winding
. - Winsys
Feature - WinsysID
- Identifies specific window system backends that Cogl supports.
Constants§
Traits§
- Framebuffer
Ext - Trait containing all
Framebuffer
methods. - Object
Ext - Trait containing all
Object
methods. - Texture
Ext - Trait containing all
Texture
methods.