33400c0aae
Although we wouldn't recommend developers try and interleve OpenGL drawing with Cogl drawing - we would prefer patches that improve Cogl to avoid this if possible - we are providing a simple mechanism that will at least give developers a fighting chance if they find it necissary. Note: we aren't helping developers change OpenGL state to modify the behaviour of Cogl drawing functions - it's unlikley that can ever be reliably supported - but if they are trying to do something like: - setup some OpenGL state. - draw using OpenGL (e.g. glDrawArrays() ) - reset modified OpenGL state. - continue using Cogl to draw They should surround their blocks of raw OpenGL with cogl_begin_gl() and cogl_end_gl(): cogl_begin_gl (); - setup some OpenGL state. - draw using OpenGL (e.g. glDrawArrays() ) - reset modified OpenGL state. cogl_end_gl (); - continue using Cogl to draw Again; we aren't supporting code like this: - setup some OpenGL state. - use Cogl to draw - reset modified OpenGL state. When the internals of Cogl evolves, this is very liable to break. cogl_begin_gl() will flush all internally batched Cogl primitives, and emit all internal Cogl state to OpenGL as if it were going to draw something itself. The result is that the OpenGL modelview matrix will be setup; the state corresponding to the current source material will be setup and other world state such as backface culling, depth and fogging enabledness will be also be sent to OpenGL. Note: no special material state is flushed, so if developers want Cogl to setup a simplified material state it is the their responsibility to set a simple source material before calling cogl_begin_gl. E.g. by calling cogl_set_source_color4ub(). Note: It is the developers responsibility to restore any OpenGL state that they modify to how it was after calling cogl_begin_gl() if they don't do this then the result of further Cogl calls is undefined.
469 lines
8.7 KiB
Plaintext
469 lines
8.7 KiB
Plaintext
<SECTION>
|
|
<FILE>cogl</FILE>
|
|
<TITLE>General API</TITLE>
|
|
COGL_INVALID_HANDLE
|
|
CoglHandle
|
|
cogl_handle_ref
|
|
cogl_handle_unref
|
|
|
|
<SUBSECTION>
|
|
CoglFuncPtr
|
|
COGL_PIXEL_FORMAT_24
|
|
COGL_PIXEL_FORMAT_32
|
|
COGL_A_BIT
|
|
COGL_BGR_BIT
|
|
COGL_AFIRST_BIT
|
|
COGL_PREMULT_BIT
|
|
COGL_UNORDERED_MASK
|
|
COGL_UNPREMULT_MASK
|
|
CoglPixelFormat
|
|
CoglBufferTarget
|
|
CoglBufferBit
|
|
CoglAttributeType
|
|
|
|
<SUBSECTION>
|
|
CoglFeatureFlags
|
|
cogl_get_features
|
|
cogl_features_available
|
|
cogl_check_extension
|
|
cogl_get_proc_address
|
|
cogl_get_option_group
|
|
cogl_gl_error_to_string
|
|
|
|
<SUBSECTION>
|
|
cogl_push_matrix
|
|
cogl_pop_matrix
|
|
cogl_scale
|
|
cogl_translate
|
|
cogl_rotate
|
|
cogl_frustum
|
|
cogl_perspective
|
|
cogl_ortho
|
|
|
|
<SUBSECTION>
|
|
cogl_get_modelview_matrix
|
|
cogl_set_modelview_matrix
|
|
cogl_get_projection_matrix
|
|
cogl_set_projection_matrix
|
|
cogl_viewport
|
|
cogl_get_viewport
|
|
|
|
<SUBSECTION>
|
|
cogl_clear
|
|
cogl_get_bitmasks
|
|
cogl_set_depth_test_enabled
|
|
cogl_get_depth_test_enabled
|
|
cogl_set_backface_culling_enabled
|
|
cogl_get_backface_culling_enabled
|
|
|
|
<SUBSECTION>
|
|
CoglFogMode
|
|
cogl_set_fog
|
|
cogl_disable_fog
|
|
|
|
<SUBSECTION>
|
|
cogl_set_source
|
|
cogl_set_source_color
|
|
cogl_set_source_color4ub
|
|
cogl_set_source_color4f
|
|
cogl_set_source_texture
|
|
|
|
<SUBSECTION>
|
|
CoglReadPixelsFlags
|
|
cogl_read_pixels
|
|
|
|
<SUBSECTION>
|
|
cogl_flush
|
|
cogl_begin_gl
|
|
cogl_end_gl
|
|
|
|
<SUBSECTION Standard>
|
|
COGL_TYPE_ATTRIBUTE_TYPE
|
|
COGL_TYPE_BUFFER_BIT
|
|
COGL_TYPE_BUFFER_TARGET
|
|
COGL_TYPE_DEBUG_FLAGS
|
|
COGL_TYPE_FEATURE_FLAGS
|
|
COGL_TYPE_FIXED
|
|
COGL_TYPE_FOG_MODE
|
|
COGL_TYPE_HANDLE
|
|
COGL_TYPE_INDICES_TYPE
|
|
COGL_TYPE_MATERIAL_ALPHA_FUNC
|
|
COGL_TYPE_MATERIAL_FILTER
|
|
COGL_TYPE_MATERIAL_LAYER_TYPE
|
|
COGL_TYPE_MATRIX_MODE
|
|
COGL_TYPE_PIXEL_FORMAT
|
|
COGL_TYPE_SHADER_TYPE
|
|
COGL_TYPE_TEXTURE_FLAGS
|
|
COGL_TYPE_VERTICES_MODE
|
|
|
|
<SUBSECTION Private>
|
|
cogl_util_next_p2
|
|
cogl_attribute_type_get_type
|
|
cogl_buffer_bit_get_type
|
|
cogl_buffer_target_get_type
|
|
cogl_debug_flags_get_type
|
|
cogl_feature_flags_get_type
|
|
cogl_fixed_get_type
|
|
cogl_fog_mode_get_type
|
|
cogl_handle_get_type
|
|
cogl_indices_type_get_type
|
|
cogl_material_alpha_func_get_type
|
|
cogl_material_filter_get_type
|
|
cogl_material_layer_type_get_type
|
|
cogl_matrix_mode_get_type
|
|
cogl_pixel_format_get_type
|
|
cogl_shader_type_get_type
|
|
cogl_texture_flags_get_type
|
|
cogl_vertices_mode_get_type
|
|
GE
|
|
COGL_NOTE
|
|
CoglDebugFlags
|
|
cogl_debug_flags
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-clipping</FILE>
|
|
CoglClipStackState
|
|
cogl_clip_push
|
|
cogl_clip_push_from_path
|
|
cogl_clip_push_from_path_preserve
|
|
cogl_clip_push_window_rect
|
|
cogl_clip_pop
|
|
cogl_clip_stack_save
|
|
cogl_clip_stack_restore
|
|
cogl_clip_ensure
|
|
<SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-primitives</FILE>
|
|
<TITLE>Primitives</TITLE>
|
|
<SUBSECTION>
|
|
cogl_rectangle
|
|
cogl_rectangles
|
|
cogl_rectangle_with_texture_coords
|
|
cogl_rectangles_with_texture_coords
|
|
cogl_rectangle_with_multitexture_coords
|
|
cogl_polygon
|
|
|
|
<SUBSECTION>
|
|
cogl_path_new
|
|
cogl_path_move_to
|
|
cogl_path_close
|
|
cogl_path_line_to
|
|
cogl_path_curve_to
|
|
cogl_path_arc
|
|
cogl_path_rel_move_to
|
|
cogl_path_rel_line_to
|
|
cogl_path_rel_curve_to
|
|
cogl_path_line
|
|
cogl_path_polyline
|
|
cogl_path_polygon
|
|
cogl_path_rectangle
|
|
cogl_path_round_rectangle
|
|
cogl_path_ellipse
|
|
|
|
<SUBSECTION>
|
|
cogl_path_fill
|
|
cogl_path_fill_preserve
|
|
cogl_path_stroke
|
|
cogl_path_stroke_preserve
|
|
cogl_color
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-bitmap</FILE>
|
|
<TITLE>Bitmaps</TITLE>
|
|
cogl_bitmap_new_from_file
|
|
cogl_bitmap_get_size_from_file
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-texture</FILE>
|
|
<TITLE>Textures</TITLE>
|
|
CoglTextureVertex
|
|
CoglTextureFlags
|
|
cogl_texture_new_with_size
|
|
cogl_texture_new_from_file
|
|
cogl_texture_new_from_data
|
|
cogl_texture_new_from_foreign
|
|
cogl_texture_new_from_bitmap
|
|
cogl_is_texture
|
|
cogl_texture_ref
|
|
cogl_texture_unref
|
|
|
|
<SUBSECTION>
|
|
cogl_texture_get_width
|
|
cogl_texture_get_height
|
|
cogl_texture_get_format
|
|
cogl_texture_get_rowstride
|
|
cogl_texture_get_max_waste
|
|
cogl_texture_is_sliced
|
|
cogl_texture_get_gl_texture
|
|
cogl_texture_get_data
|
|
cogl_texture_set_region
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-shaders</FILE>
|
|
<TITLE>Shaders and Programmable Pipeline</TITLE>
|
|
CoglShaderType
|
|
cogl_create_shader
|
|
cogl_shader_ref
|
|
cogl_shader_unref
|
|
cogl_is_shader
|
|
cogl_shader_source
|
|
cogl_shader_compile
|
|
cogl_shader_get_info_log
|
|
cogl_shader_get_type
|
|
cogl_shader_is_compiled
|
|
|
|
<SUBSECTION>
|
|
cogl_create_program
|
|
cogl_program_ref
|
|
cogl_program_unref
|
|
cogl_is_program
|
|
cogl_program_attach_shader
|
|
cogl_program_link
|
|
cogl_program_use
|
|
cogl_program_get_uniform_location
|
|
cogl_program_uniform_1f
|
|
cogl_program_uniform_1i
|
|
cogl_program_uniform_float
|
|
cogl_program_uniform_int
|
|
cogl_program_uniform_matrix
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-offscreen</FILE>
|
|
<TITLE>Offscreen Buffers</TITLE>
|
|
cogl_offscreen_new_to_texture
|
|
cogl_offscreen_ref
|
|
cogl_offscreen_unref
|
|
cogl_is_offscreen
|
|
cogl_set_draw_buffer
|
|
cogl_pop_draw_buffer
|
|
cogl_push_draw_buffer
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-fixed</FILE>
|
|
<TITLE>Fixed Point API</TITLE>
|
|
CoglFixed
|
|
COGL_FIXED_BITS
|
|
COGL_FIXED_Q
|
|
COGL_FIXED_MAX
|
|
COGL_FIXED_MIN
|
|
|
|
<SUBSECTION>
|
|
COGL_FIXED_FROM_FLOAT
|
|
COGL_FIXED_TO_FLOAT
|
|
COGL_FIXED_FROM_INT
|
|
COGL_FIXED_TO_INT
|
|
COGL_FIXED_FROM_DOUBLE
|
|
COGL_FIXED_TO_DOUBLE
|
|
COGL_FLOAT_TO_INT
|
|
COGL_FLOAT_TO_UINT
|
|
|
|
<SUBSECTION>
|
|
COGL_FIXED_EPSILON
|
|
COGL_FIXED_1
|
|
COGL_FIXED_0_5
|
|
COGL_FIXED_30
|
|
COGL_FIXED_45
|
|
COGL_FIXED_60
|
|
COGL_FIXED_90
|
|
COGL_FIXED_120
|
|
COGL_FIXED_180
|
|
COGL_FIXED_240
|
|
COGL_FIXED_255
|
|
COGL_FIXED_270
|
|
COGL_FIXED_360
|
|
|
|
<SUBSECTION>
|
|
COGL_FIXED_MUL
|
|
COGL_FIXED_DIV
|
|
COGL_FIXED_MUL_DIV
|
|
COGL_FIXED_FAST_DIV
|
|
COGL_FIXED_FAST_MUL
|
|
COGL_FIXED_FRACTION
|
|
COGL_FIXED_FLOOR
|
|
COGL_FIXED_CEIL
|
|
|
|
<SUBSECTION>
|
|
COGL_FIXED_2_PI
|
|
COGL_FIXED_PI
|
|
COGL_FIXED_PI_2
|
|
COGL_FIXED_PI_4
|
|
COGL_RADIANS_TO_DEGREES
|
|
|
|
<SUBSECTION>
|
|
COGL_SQRTI_ARG_10_PERCENT
|
|
COGL_SQRTI_ARG_5_PERCENT
|
|
COGL_SQRTI_ARG_MAX
|
|
cogl_sqrti
|
|
|
|
<SUBSECTION>
|
|
cogl_fixed_atan2
|
|
cogl_fixed_atani
|
|
cogl_fixed_cos
|
|
cogl_fixed_log2
|
|
cogl_fixed_pow
|
|
cogl_fixed_pow2
|
|
cogl_fixed_sin
|
|
cogl_fixed_sqrt
|
|
cogl_fixed_tan
|
|
|
|
<SUBSECTION>
|
|
CoglAngle
|
|
COGL_ANGLE_FROM_DEG
|
|
COGL_ANGLE_FROM_DEGX
|
|
COGL_ANGLE_TO_DEG
|
|
COGL_ANGLE_TO_DEGX
|
|
cogl_angle_cos
|
|
cogl_angle_sin
|
|
cogl_angle_tan
|
|
|
|
<SUBSECTION Private>
|
|
cogl_fixed_mul
|
|
cogl_fixed_div
|
|
cogl_fixed_mul_div
|
|
cogl_double_to_fixed
|
|
cogl_double_to_int
|
|
cogl_double_to_unit
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-color</FILE>
|
|
<TITLE>Color Type</TITLE>
|
|
CoglColor
|
|
cogl_color_new
|
|
cogl_color_copy
|
|
cogl_color_free
|
|
cogl_color_set_from_4ub
|
|
cogl_color_set_from_4f
|
|
|
|
<SUBSECTION>
|
|
cogl_color_get_red
|
|
cogl_color_get_green
|
|
cogl_color_get_blue
|
|
cogl_color_get_alpha
|
|
|
|
<SUBSECTION>
|
|
cogl_color_get_red_byte
|
|
cogl_color_get_green_byte
|
|
cogl_color_get_blue_byte
|
|
cogl_color_get_alpha_byte
|
|
|
|
<SUBSECTION>
|
|
cogl_color_get_red_float
|
|
cogl_color_get_green_float
|
|
cogl_color_get_blue_float
|
|
cogl_color_get_alpha_float
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-vertex-buffer</FILE>
|
|
<TITLE>Vertex Buffers</TITLE>
|
|
cogl_vertex_buffer_new
|
|
cogl_vertex_buffer_get_n_vertices
|
|
cogl_vertex_buffer_ref
|
|
cogl_vertex_buffer_unref
|
|
cogl_vertex_buffer_add
|
|
cogl_vertex_buffer_delete
|
|
cogl_vertex_buffer_submit
|
|
cogl_vertex_buffer_disable
|
|
cogl_vertex_buffer_enable
|
|
cogl_vertex_buffer_draw
|
|
|
|
<SUBSECTION>
|
|
CoglIndicesType
|
|
cogl_vertex_buffer_indices_new
|
|
cogl_vertex_buffer_delete_indices
|
|
cogl_vertex_buffer_draw_elements
|
|
cogl_vertex_buffer_indices_get_for_quads
|
|
<SUBSECTION Private>
|
|
CoglVertexBufferAttribFlags
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_MASK
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_TYPE_MASK
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-matrix</FILE>
|
|
<TITLE>Matrices</TITLE>
|
|
CoglMatrix
|
|
CoglMatrixMode
|
|
CoglMatrixStack
|
|
cogl_matrix_init_identity
|
|
cogl_matrix_frustum
|
|
cogl_matrix_ortho
|
|
cogl_matrix_perspective
|
|
cogl_matrix_transform_point
|
|
cogl_matrix_multiply
|
|
cogl_matrix_rotate
|
|
cogl_matrix_translate
|
|
cogl_matrix_scale
|
|
cogl_matrix_init_from_array
|
|
cogl_matrix_get_array
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-material</FILE>
|
|
<TITLE>Materials</TITLE>
|
|
cogl_material_new
|
|
cogl_material_ref
|
|
cogl_material_unref
|
|
cogl_is_material
|
|
cogl_material_set_color
|
|
cogl_material_set_color4ub
|
|
cogl_material_set_color4f
|
|
cogl_material_get_color
|
|
cogl_material_set_ambient
|
|
cogl_material_get_ambient
|
|
cogl_material_set_diffuse
|
|
cogl_material_get_diffuse
|
|
cogl_material_set_ambient_and_diffuse
|
|
cogl_material_set_emission
|
|
cogl_material_get_emission
|
|
cogl_material_set_specular
|
|
cogl_material_get_specular
|
|
cogl_material_set_shininess
|
|
cogl_material_get_shininess
|
|
CoglMaterialAlphaFunc
|
|
cogl_material_set_alpha_test_function
|
|
CoglBlendStringChannelMask
|
|
CoglBlendStringColorSourceType
|
|
CoglBlendStringContext
|
|
CoglBlendStringError
|
|
CoglBlendStringFunctionType
|
|
COGL_BLEND_STRING_ERROR
|
|
cogl_material_set_blend
|
|
cogl_material_set_blend_constant
|
|
cogl_material_set_layer
|
|
cogl_material_remove_layer
|
|
cogl_material_set_layer_combine
|
|
cogl_material_set_layer_combine_constant
|
|
cogl_material_set_layer_matrix
|
|
cogl_material_get_layers
|
|
CoglMaterialFilter
|
|
cogl_material_set_layer_filters
|
|
cogl_material_layer_get_type
|
|
cogl_material_layer_get_texture
|
|
cogl_material_layer_get_min_filter
|
|
cogl_material_layer_get_mag_filter
|
|
<SUBSECTION Private>
|
|
CoglMaterial
|
|
CoglMaterialFlags
|
|
CoglMaterialLayerFlags
|
|
CoglMaterialLayerPrivFlags
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cogl-material-internals</FILE>
|
|
<TITLE>Material Internals</TITLE>
|
|
CoglMaterialLayer
|
|
cogl_material_get_layers
|
|
CoglMaterialLayerType
|
|
cogl_material_layer_get_type
|
|
cogl_material_layer_get_texture
|
|
</SECTION>
|