Flags

Details

class Cogl.BufferAccess(value)

Bases: GLib.Flags

The access hints for Cogl.buffer_set_update_hint()

New in version 1.2.

READ = 1

the buffer will be read

WRITE = 2

the buffer will written to

READ_WRITE = 3

the buffer will be used for both reading and writing

class Cogl.BufferBit(value)

Bases: GObject.GFlags

Types of auxiliary buffers

New in version 1.0.

COLOR = 1

Selects the primary color buffer

DEPTH = 2

Selects the depth buffer

STENCIL = 4

Selects the stencil buffer

class Cogl.BufferMapHint(value)

Bases: GLib.Flags

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

New in version 1.4.

_ = 1

Tells Cogl that you plan to replace all the buffer’s contents. When this flag is used to map a buffer, the entire contents of the buffer become undefined, even if only a subregion of the buffer is mapped.

_RANGE = 2

Tells Cogl that you plan to replace all the contents of the mapped region. The contents of the region specified are undefined after this flag is used to map a buffer.

class Cogl.BufferTarget(value)

Bases: GObject.GFlags

Target flags for FBOs.

New in version 0.8.

WINDOW_BUFFER = 2

FIXME

OFFSCREEN_BUFFER = 4

FIXME

class Cogl.ColorMask(value)

Bases: GObject.GFlags

Defines a bit mask of color channels. This can be used with Cogl.Pipeline.set_color_mask() for example to define which color channels should be written to the current framebuffer when drawing something.

NONE = 0

None of the color channels are masked

RED = 1

Masks the red color channel

ALL = 15

All of the color channels are masked

GREEN = 2

Masks the green color channel

BLUE = 4

Masks the blue color channel

ALPHA = 8

Masks the alpha color channel

class Cogl.FeatureFlags(value)

Bases: GObject.GFlags

Flags for the supported features.

New in version 0.8.

STENCIL_BUFFER = 1024

Stencil buffer support

SHADERS_ARBFP = 1048576

ARBFP support

OFFSCREEN_MULTISAMPLE = 128

Multisample support on FBOs

TEXTURE_NPOT_REPEAT = 131072

Repeat modes other than Cogl.PipelineWrapMode.CLAMP_TO_EDGE are supported by the hardware.

TEXTURE_READ_PIXELS = 16

glReadPixels() support

DEPTH_RANGE = 16384

cogl_material_set_depth_range() support

DEPTH_TEXTURE = 16777216

Whether Cogl.Framebuffer support rendering the depth buffer to a texture.

TEXTURE_RECTANGLE = 2

ARB_texture_rectangle support

VBOS = 2048

VBO support

MAP_BUFFER_FOR_READ = 2097152

Whether Cogl.buffer_map() is supported with Cogl.BufferAccess including read support.

OFFSCREEN_BLIT = 256

Blit support on FBOs

POINT_SPRITE = 262144

Whether cogl_material_set_layer_point_sprite_coords_enabled() is supported.

SHADERS_GLSL = 32

GLSL support

TEXTURE_NPOT_BASIC = 32768

The hardware supports non power of two textures, but you also need to check the Cogl.FeatureFlags.TEXTURE_NPOT_MIPMAP and Cogl.FeatureFlags.TEXTURE_NPOT_REPEAT features to know if the hardware supports npot texture mipmaps or repeat modes other than Cogl.PipelineWrapMode.CLAMP_TO_EDGE respectively.

TEXTURE_NPOT = 4

Non power of two textures are supported by the hardware. This is a equivalent to the Cogl.FeatureFlags.TEXTURE_NPOT_BASIC, Cogl.FeatureFlags.TEXTURE_NPOT_MIPMAP and Cogl.FeatureFlags.TEXTURE_NPOT_REPEAT features combined.

PBOS = 4096

PBO support

MAP_BUFFER_FOR_WRITE = 4194304

Whether Cogl.buffer_map() is supported with Cogl.BufferAccess including write support.

FOUR_CLIP_PLANES = 512

At least 4 clip planes available

TEXTURE_3D = 524288

3D texture support

OFFSCREEN = 64

FBO support

TEXTURE_NPOT_MIPMAP = 65536

Mipmapping is supported in conjuntion with non power of two textures.

TEXTURE_YUV = 8

ycbcr conversion support

UNSIGNED_INT_INDICES = 8192

Set if Cogl.IndicesType.INT is supported in cogl_vertex_buffer_indices_new().

ONSCREEN_MULTIPLE = 8388608
class Cogl.ReadPixelsFlags(value)

Bases: GObject.GFlags

Flags for Cogl.Framebuffer.read_pixels_into_bitmap()

New in version 1.0.

COLOR_BUFFER = 1

Read from the color buffer

class Cogl.RendererConstraint(value)

Bases: GLib.Flags

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.

Applications should ideally minimize how many of these constraints they depend on to ensure maximum portability.

New in version 1.10.

USES_X11 = 1

Require the renderer to be X11 based

USES_XLIB = 2

Require the renderer to be X11 based and use Xlib

USES_EGL = 4

Require the renderer to be EGL based

SUPPORTS_COGL_GLES2 = 8

Require that the renderer supports creating a Cogl.GLES2Context via Cogl.GLES2Context.new(). This can be used to integrate GLES 2.0 code into Cogl based applications.

class Cogl.TextureFlags(value)

Bases: GObject.GFlags

Flags to pass to the cogl_texture_new_* family of functions.

New in version 1.0.

NONE = 0

No flags specified

NO_AUTO_MIPMAP = 1

Disables the automatic generation of the mipmap pyramid from the base level image whenever it is updated. The mipmaps are only generated when the texture is rendered with a mipmap filter so it should be free to leave out this flag when using other filtering modes

NO_SLICING = 2

Disables the slicing of the texture

NO_ATLAS = 4

Disables the insertion of the texture inside the texture atlas used by Cogl