Crate cogl[][src]

Structs

AtlasTexture
AtlasTextureClass
Attribute
AttributeBuffer
AttributeBufferClass
AttributeClass
Bitmap
BitmapClass
BufferAccess
BufferBit
BufferMapHint
BufferTarget
Color
ColorMask
Context
ContextClass
DebugObjectTypeInfo
DepthState
Display
DisplayClass
Euler
FeatureFlags
Fence
FenceClosure
Fixed
FixedClass
FrameClosure
FrameInfo
FrameInfoClass
Framebuffer
GLES2Context
GLES2ContextClass
GLES2Vtable
GtypeObject
Handle
IndexBuffer
IndexBufferClass
Indices
IndicesClass
KmsCrtc
Material
MaterialLayer
Matrix
MatrixEntry
MatrixStack
MatrixStackClass
Object
ObjectClass
Offscreen
OffscreenClass
Onscreen
OnscreenClass
OnscreenDirtyClosure
OnscreenDirtyInfo
OnscreenResizeClosure
OnscreenTemplate
OnscreenTemplateClass
Output
OutputClass
Pipeline
PipelineClass
PixelBuffer
PixelBufferClass
PollFD
Primitive
PrimitiveClass
Quaternion
ReadPixelsFlags
Renderer
RendererClass
RendererConstraint
Snippet
SnippetClass
SubTexture
SubTextureClass
SwapChain
SwapChainClass
Texture
Texture2D
Texture2DClass
Texture2DSliced
Texture2DSlicedClass
Texture3D
Texture3DClass
TextureFlags
TexturePixmapX11
TexturePixmapX11Class
TextureRectangle
TextureRectangleClass
TextureVertex
UserDataKey
VertexP2
VertexP2C4
VertexP2T2
VertexP2T2C4
VertexP3
VertexP3C4
VertexP3T2
VertexP3T2C4

Enums

AttributeType

Data types for the components of a vertex attribute.

BitmapError

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.

BlendStringError

Error enumeration for the blend strings parser

BufferError

Error enumeration for Buffer

BufferUpdateHint

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

DepthTestFunction

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 or cogl_has_features.

FilterReturn

Return values for the CoglXlibFilterFunc and CoglWin32FilterFunc 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:

FrameEvent

Identifiers that are passed to CoglFrameCallback functions (registered using 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 FrameInfo object.

FramebufferError
GLES2ContextError

Error codes that relate to the cogl_gles2_context api.

IndicesType

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.

MaterialAlphaFunc

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.

MaterialFilter

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.

MaterialLayerType

Available types of layers for a Material. This enumeration might be expanded in later versions.

MaterialWrapMode

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.

PipelineAlphaFunc

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.

PipelineCullFaceMode

Specifies which faces should be culled. This can be set on a pipeline using Pipeline::set_cull_face_mode.

PipelineFilter

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.

PipelineWrapMode

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.

PixelFormat

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.

PollFDEvent

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.

RendererError
ShaderType

Types of shaders

SnippetHook

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

StereoMode

Represents how draw should affect the two buffers of a stereo framebuffer. See Framebuffer::set_stereo_mode.

SubpixelOrder

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.

SystemError

Error enumeration for Cogl

TextureComponents

See Texture::set_components.

TextureError

Error codes that can be thrown when allocating textures.

TexturePixmapX11Error

Error codes that can be thrown when performing texture-pixmap-x11 operations.

TexturePixmapX11ReportLevel
TextureType

Constants representing the underlying hardware texture type of a Texture.

VerticesMode

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.

WinsysFeature
WinsysID

Identifies specific window system backends that Cogl supports.

Constants

NONE_FRAMEBUFFER
NONE_OBJECT
NONE_TEXTURE

Traits

FramebufferExt

Trait containing all Framebuffer methods.

ObjectExt

Trait containing all Object methods.

TextureExt

Trait containing all Texture methods.

Functions

source_new

Type Definitions

Angle
Buffer
MetaTexture
PrimitiveTexture
UserDataDestroyCallback