cogl-1.0

---

Description:

COGL is a low level OpenGL abstraction library developed for (and part of) Clutter. It is used primarily by Clutter to provide a common rendering API that works transparently across OpenGL >=1.4, OpenGL ES 1.1 and OpenGL ES 2.0.

Warning: This package is deprecated!

• Home: http://www.clutter-project.org/
• C-Documentation: https://gitlab.gnome.org/GNOME/cogl/-/tree/cogl-1.22/doc/reference/cogl/
• Binding-Maintainer(s): Ali Sabil
• Devhelp-Package download

Content:

Namespaces:

• Cogl

Classes:

• Bitmap
• Buffer
• Framebuffer
• Handle
• Material
• MaterialLayer
• Object
• Offscreen
• PangoFontMap
• PangoRenderer
• PangoRendererClass
• Path
• PixelArray
• PixelBuffer
• Program
• Shader
• Texture
• UserDataKey
• Vector3
• VertexBuffer
• VertexBufferIndices - Type used for storing references to cogl objects, the CoglHandle is a fully opaque type without any public data members.

Structs:

• Angle - Integer representation of an angle such that 1024 corresponds to full circle (i.e., 2 * pi).
• Bool - A boolean data type used throughout the Cogl C api.
• Color - A structure for holding a color definition.
• Fixed - Fixed point number using a (16.16) notation.
• Matrix - A CoglMatrix holds a 4x4 transform matrix.
• TextureVertex - Used to specify vertex information when calling polygon

Enums:

• AttributeType - Data types for the components of a vertex attribute.
• BitmapError - Error codes that can be thrown when performing bitmap operations.
• BufferAccess
• BufferBit - Types of auxiliary buffers
• BufferMapHint
• BufferTarget - Target flags for FBOs.
• BufferUpdateHint
• 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.
• DriverError
• Error
• FeatureFlags - Flags for the supported features.
• FogMode - The fog mode determines the equation used to calculate the fogging blend factor while fogging is enabled.
• 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.
• MaterialFilter - Texture filtering is used whenever the current pixel maps either to more than one texture element (texel) or less than one.
• MaterialLayerType - Available types of layers for a CoglMaterial.
• MaterialWrapMode - The wrap mode specifies what happens when texture coordinates outside the range 0→1 are used.
• PathFillRule
• PixelFormat - Pixel formats used by Cogl.
• ReadPixelsFlags - Flags for cogl_framebuffer_read_pixels_into_bitmap
• ShaderType - Types of shaders
• TextureFlags - Flags to pass to the cogl_texture_new_* family of functions.
• TexturePixmapX11ReportLevel
• VerticesMode - Different ways of interpreting vertices when drawing.

Error domains:

• BlendStringError - Error enumeration for the blend strings parser

Constants:

• public const int AFIRST_BIT
• public const int A_BIT
• public const int BGR_BIT
• public const int CLUTTER_COGL_HAS_GL
• public const int FIXED_0_5
  The number 0.5 expressed as a Fixed number.
• public const int FIXED_1
  The number 1 expressed as a Fixed number.
• public const int FIXED_2_PI
  Two times pi, expressed as a Fixed number.
• public const int FIXED_BITS
  Evaluates to the number of bits used by the Fixed type.
• public const int FIXED_EPSILON
  A very small number expressed as a Fixed number.
• public const int FIXED_MAX
  The biggest number representable using Fixed
• public const int FIXED_MIN
  The smallest number representable using Fixed
• public const int FIXED_PI
  The number pi, expressed as a Fixed number.
• public const int FIXED_PI_2
  Half pi, expressed as a Fixed number.
• public const int FIXED_PI_4
  pi / 4, expressed as Fixed number.
• public const int FIXED_Q
  Evaluates to the number of bits used for the non-integer part of the Fixed type.
• public const int HAS_GL
• public const int HAS_X11
• public const int HAS_XLIB
• public const int PIXEL_FORMAT_24
• public const int PIXEL_FORMAT_32
• public const int PREMULT_BIT
• public const int RADIANS_TO_DEGREES
  Evaluates to 180 / pi in fixed point notation.
• public const int SQRTI_ARG_10_PERCENT
  Maximum argument that can be passed to sqrti for which the resulting error is < 10%
• public const int SQRTI_ARG_5_PERCENT
  Maximum argument that can be passed to sqrti for which the resulting error is < 5%
• public const int SQRTI_ARG_MAX
  Maximum argument that can be passed to sqrti function.
• public const int TEXTURE_MAX_WASTE
• public const int UNORDERED_MASK
• public const int UNPREMULT_MASK

Delegates:

• public delegate void FuncPtr ()
  The type used by cogl for function pointers, note that this type is used as a generic catch-all cast for function pointers and the actual arguments and return type may be different.
• public delegate bool MaterialLayerCallback (Material material, int layer_index)
• public delegate void UserDataDestroyCallback ()

Methods:

• public Type attribute_type_get_type ()
• public void begin_gl ()
  We do not advise nor reliably support the interleaving of raw GL drawing and Cogl drawing functions, but if you insist, begin_gl and end_gl provide a simple mechanism that may at least give you a fighting chance of succeeding.
• public Type blend_string_error_get_type ()
• public bool check_extension (string name, string ext)
  Check whether name occurs in list of extensions in ext .
• public void clear (Color color, uint buffers)
  Clears all the auxiliary buffers identified in the buffers mask, and if that includes the color buffer then the specified color is used.
• public void clip_ensure ()
  Ensures that the current clipping region has been set in GL.
• public void clip_pop ()
  Reverts the clipping region to the state before the last call to clip_push.
• public void clip_push (float x_offset, float y_offset, float width, float height)
  Specifies a rectangular clipping area for all subsequent drawing operations.
• public void clip_push_from_path ()
• public void clip_push_from_path_preserve ()
• public void clip_push_rectangle (float x0, float y0, float x1, float y1)
  Specifies a rectangular clipping area for all subsequent drawing operations.
• public void clip_push_window_rect (float x_offset, float y_offset, float width, float height)
  Specifies a rectangular clipping area for all subsequent drawing operations.
• public void clip_push_window_rectangle (int x_offset, int y_offset, int width, int height)
  Specifies a rectangular clipping area for all subsequent drawing operations.
• public void clip_stack_restore ()
  Restore the state of the clipping stack that was previously saved by clip_stack_save.
• public void clip_stack_save ()
  Save the entire state of the clipping stack and then clear all clipping.
• public Type depth_test_function_get_type ()
• public void disable_fog ()
  This function disables fogging, so primitives drawn afterwards will not be blended with any previously set fog color.
• public Fixed double_to_fixed (double value)
• public int double_to_int (double value)
• public uint double_to_uint (double value)
• public Type driver_error_get_type ()
• public void end_gl ()
  This is the counterpart to begin_gl used to delimit blocks of drawing code using raw OpenGL.
• public Type error_get_type ()
• public Type feature_flags_get_type ()
• public bool features_available (FeatureFlags features)
  Checks whether the given COGL features are available.
• public void flush ()
  This function should only need to be called in exceptional circumstances.
• public Type fog_mode_get_type ()
• public void frustum (float left, float right, float bottom, float top, float z_near, float z_far)
  Replaces the current projection matrix with a perspective matrix for a given viewing frustum defined by 4 side clip planes that all cross through the origin and 2 near and far clip planes.
• public bool get_backface_culling_enabled ()
  Queries if backface culling has been enabled via set_backface_culling_enabled
• public void get_bitmasks (out int red, out int green, out int blue, out int alpha)
  Gets the number of bitplanes used for each of the color components in the color buffer.
• public bool get_depth_test_enabled ()
  Queries if depth testing has been enabled via cogl_set_depth_test_enable
• public FeatureFlags get_features ()
  Returns all of the features supported by COGL.
• public void get_modelview_matrix (out Matrix matrix)
  Stores the current model-view matrix in matrix.
• public OptionGroup get_option_group ()
  Retrieves the OptionGroup used by Cogl to parse the command line options.
• public unowned Path get_path ()
• public unowned FuncPtr get_proc_address (string name)
  Gets a pointer to a given GL or GL ES extension function.
• public void get_projection_matrix (out Matrix matrix)
  Stores the current projection matrix in matrix.
• public void get_viewport (float[] v)
  Stores the current viewport in v.
• public Type indices_type_get_type ()
• public bool is_path (Bitmap handle)
• public bool is_vertex_buffer_indices (Bitmap handle)
  Checks whether handle is a handle to the indices for a vertex buffer object
• public void ortho (float left, float right, float bottom, float top, float near, float far)
  Replaces the current projection matrix with an orthographic projection matrix.
• public void pango_ensure_glyph_cache_for_layout (Layout layout)
• public void pango_render_layout (Layout layout, int x, int y, Color color, int flags)
• public void pango_render_layout_line (LayoutLine line, int x, int y, Color color)
• public void pango_render_layout_subpixel (Layout layout, int x, int y, Color color, int flags)
• public void perspective (float fovy, float aspect, float z_near, float z_far)
  Replaces the current projection matrix with a perspective matrix based on the provided values.
• public Type pixel_format_get_type ()
• public void polygon (TextureVertex[] vertices, bool use_color)
  Draws a convex polygon using the current source material to fill / texture with according to the texture coordinates passed.
• public void pop_framebuffer ()
  Restores the framebuffer that was previously at the top of the stack.
• public void pop_matrix ()
  Restores the current model-view matrix from the matrix stack.
• public void push_framebuffer (Framebuffer buffer)
  Redirects all subsequent drawing to the specified framebuffer.
• public void push_matrix ()
  Stores the current model-view matrix on the matrix stack.
• public void read_pixels (int x, int y, int width, int height, ReadPixelsFlags source, PixelFormat format, uint8[] pixels)
  This reads a rectangle of pixels from the current framebuffer where position (0, 0) is the top left.
• public Type read_pixels_flags_get_type ()
• public void rectangle (float x_1, float y_1, float x_2, float y_2)
  Fills a rectangle at the given coordinates with the current source material
• public void rectangle_with_multitexture_coords (float x1, float y1, float x2, float y2, float tex_coords, int tex_coords_len)
  This function draws a rectangle using the current source material to texture or fill with.
• public void rectangle_with_texture_coords (float x1, float y1, float x2, float y2, float tx1, float ty1, float tx2, float ty2)
  Draw a rectangle using the current material and supply texture coordinates to be used for the first texture layer of the material.
• public void rectangles (float[] verts, uint n_rects)
  Draws a series of rectangles in the same way that rectangle does.
• public void rectangles_with_texture_coords (float[] verts, uint n_rects)
  Draws a series of rectangles in the same way that rectangle_with_texture_coords does.
• public void rotate (float angle, float x, float y, float z)
  Multiplies the current model-view matrix by one that rotates the model around the vertex specified by x, y and z.
• public void scale (float x, float y, float z)
  Multiplies the current model-view matrix by one that scales the x, y and z axes by the given values.
• public void set_backface_culling_enabled (bool setting)
  Sets whether textures positioned so that their backface is showing should be hidden.
• public void set_depth_test_enabled (bool setting)
  Sets whether depth testing is enabled.
• public void set_fog (Color fog_color, FogMode mode, float density, float z_near, float z_far)
  Enables fogging.
• public void set_framebuffer (Framebuffer buffer)
  This redirects all subsequent drawing to the specified framebuffer.
• public void set_modelview_matrix (Matrix matrix)
  Loads matrix as the new model-view matrix.
• public void set_path (Path path)
• public void set_projection_matrix (Matrix matrix)
  Loads matrix as the new projection matrix.
• public void set_source (Material material)
  This function changes the material at the top of the source stack.
• public void set_source_color (Color color)
  This is a convenience function for creating a solid fill source material from the given color.
• public void set_source_color4f (float red, float green, float blue, float alpha)
  This is a convenience function for creating a solid fill source material from the given color using normalized values for each component.
• public void set_source_color4ub (uchar red, uchar green, uchar blue, uchar alpha)
  This is a convenience function for creating a solid fill source material from the given color using unsigned bytes for each component.
• public void set_source_texture (Texture texture_handle)
  This is a convenience function for creating a material with the first layer set to texture and setting that material as the source with cogl_set_source.
• public void set_viewport (int x, int y, int width, int height)
  Replaces the current viewport with the given values.
• public int sqrti (int x)
  Very fast fixed point implementation of square root for integers.
• public void transform (Matrix matrix)
  Multiplies the current model-view matrix by the given matrix.
• public void translate (float x, float y, float z)
  Multiplies the current model-view matrix by one that translates the model along all three axes according to the given values.
• public Type vertices_mode_get_type ()
• public void viewport (uint width, uint height)
  Replace the current viewport with the given values.