docs: Put deprecated Cogl symbols into new section
This adds a "Cogl deprecated API" chapter to the Cogl reference manual so we can group all the documentation for deprecated symbols together instead of having them clutter up the documentation of symbols we would rather developers used.
This commit is contained in:
parent
779c780500
commit
37d0dbe6b2
@ -98,6 +98,34 @@
|
|||||||
|
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|
||||||
|
<chapter>
|
||||||
|
<title>Cogl deprecated API</title>
|
||||||
|
|
||||||
|
<section id="cogl-deprecated">
|
||||||
|
|
||||||
|
<title>About the deprecated API</title>
|
||||||
|
|
||||||
|
<para>Cogl has evolved from once being a thin abstraction over
|
||||||
|
OpenGL and GLES where a lot of OpenGL's state machine style APIs
|
||||||
|
were simply rebranded as Cogl API into the more distinguished API
|
||||||
|
style we have today. The result of this evolution though is that
|
||||||
|
some of the APIs are considered deprecated and because we plan to
|
||||||
|
remove them at the next opportunity we have to break the API
|
||||||
|
developers should aim to avoid these functions to keep their code
|
||||||
|
working with future major versions of Cogl.</para>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<xi:include href="xml/cogl-deprecated.xml"/>
|
||||||
|
<xi:include href="xml/cogl-texture-deprecated.xml"/>
|
||||||
|
<xi:include href="xml/cogl-material-deprecated.xml"/>
|
||||||
|
<xi:include href="xml/cogl-clipping-deprecated.xml"/>
|
||||||
|
<xi:include href="xml/cogl-vertex-buffer-deprecated.xml"/>
|
||||||
|
<xi:include href="xml/cogl-shaders-deprecated.xml"/>
|
||||||
|
<xi:include href="xml/cogl-offscreen-deprecated.xml"/>
|
||||||
|
|
||||||
|
</chapter>
|
||||||
|
|
||||||
<chapter id="coglglossary">
|
<chapter id="coglglossary">
|
||||||
<title>Glossaries</title>
|
<title>Glossaries</title>
|
||||||
|
|
||||||
|
@ -23,7 +23,6 @@ CoglAttributeType
|
|||||||
CoglFeatureFlags
|
CoglFeatureFlags
|
||||||
cogl_get_features
|
cogl_get_features
|
||||||
cogl_features_available
|
cogl_features_available
|
||||||
cogl_check_extension
|
|
||||||
cogl_get_proc_address
|
cogl_get_proc_address
|
||||||
cogl_get_option_group
|
cogl_get_option_group
|
||||||
|
|
||||||
@ -43,15 +42,11 @@ cogl_get_modelview_matrix
|
|||||||
cogl_set_modelview_matrix
|
cogl_set_modelview_matrix
|
||||||
cogl_get_projection_matrix
|
cogl_get_projection_matrix
|
||||||
cogl_set_projection_matrix
|
cogl_set_projection_matrix
|
||||||
cogl_viewport
|
|
||||||
cogl_set_viewport
|
cogl_set_viewport
|
||||||
cogl_get_viewport
|
cogl_get_viewport
|
||||||
|
|
||||||
<SUBSECTION>
|
<SUBSECTION>
|
||||||
cogl_clear
|
cogl_clear
|
||||||
cogl_get_bitmasks
|
|
||||||
cogl_set_depth_test_enabled
|
|
||||||
cogl_get_depth_test_enabled
|
|
||||||
cogl_set_backface_culling_enabled
|
cogl_set_backface_culling_enabled
|
||||||
cogl_get_backface_culling_enabled
|
cogl_get_backface_culling_enabled
|
||||||
|
|
||||||
@ -139,13 +134,6 @@ cogl_clip_push_window_rectangle
|
|||||||
cogl_clip_push_from_path
|
cogl_clip_push_from_path
|
||||||
cogl_clip_push_from_path_preserve
|
cogl_clip_push_from_path_preserve
|
||||||
cogl_clip_pop
|
cogl_clip_pop
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
cogl_clip_push
|
|
||||||
cogl_clip_push_window_rect
|
|
||||||
cogl_clip_ensure
|
|
||||||
cogl_clip_stack_save
|
|
||||||
cogl_clip_stack_restore
|
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
@ -214,8 +202,6 @@ cogl_texture_new_from_foreign
|
|||||||
cogl_texture_new_from_bitmap
|
cogl_texture_new_from_bitmap
|
||||||
cogl_texture_new_from_sub_texture
|
cogl_texture_new_from_sub_texture
|
||||||
cogl_is_texture
|
cogl_is_texture
|
||||||
cogl_texture_ref
|
|
||||||
cogl_texture_unref
|
|
||||||
|
|
||||||
<SUBSECTION>
|
<SUBSECTION>
|
||||||
cogl_texture_get_width
|
cogl_texture_get_width
|
||||||
@ -245,8 +231,6 @@ cogl_is_texture_3d
|
|||||||
<TITLE>Shaders and Programmable Pipeline</TITLE>
|
<TITLE>Shaders and Programmable Pipeline</TITLE>
|
||||||
CoglShaderType
|
CoglShaderType
|
||||||
cogl_create_shader
|
cogl_create_shader
|
||||||
cogl_shader_ref
|
|
||||||
cogl_shader_unref
|
|
||||||
cogl_is_shader
|
cogl_is_shader
|
||||||
cogl_shader_source
|
cogl_shader_source
|
||||||
cogl_shader_compile
|
cogl_shader_compile
|
||||||
@ -256,31 +240,21 @@ cogl_shader_is_compiled
|
|||||||
|
|
||||||
<SUBSECTION>
|
<SUBSECTION>
|
||||||
cogl_create_program
|
cogl_create_program
|
||||||
cogl_program_ref
|
|
||||||
cogl_program_unref
|
|
||||||
cogl_is_program
|
cogl_is_program
|
||||||
cogl_program_attach_shader
|
cogl_program_attach_shader
|
||||||
cogl_program_link
|
cogl_program_link
|
||||||
cogl_program_use
|
|
||||||
cogl_program_get_uniform_location
|
cogl_program_get_uniform_location
|
||||||
cogl_program_set_uniform_1f
|
cogl_program_set_uniform_1f
|
||||||
cogl_program_set_uniform_1i
|
cogl_program_set_uniform_1i
|
||||||
cogl_program_set_uniform_float
|
cogl_program_set_uniform_float
|
||||||
cogl_program_set_uniform_int
|
cogl_program_set_uniform_int
|
||||||
cogl_program_set_uniform_matrix
|
cogl_program_set_uniform_matrix
|
||||||
cogl_program_uniform_1f
|
|
||||||
cogl_program_uniform_1i
|
|
||||||
cogl_program_uniform_float
|
|
||||||
cogl_program_uniform_int
|
|
||||||
cogl_program_uniform_matrix
|
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>cogl-offscreen</FILE>
|
<FILE>cogl-offscreen</FILE>
|
||||||
<TITLE>Offscreen Buffers</TITLE>
|
<TITLE>Offscreen Buffers</TITLE>
|
||||||
cogl_offscreen_new_to_texture
|
cogl_offscreen_new_to_texture
|
||||||
cogl_offscreen_ref
|
|
||||||
cogl_offscreen_unref
|
|
||||||
cogl_is_offscreen
|
cogl_is_offscreen
|
||||||
cogl_set_framebuffer
|
cogl_set_framebuffer
|
||||||
cogl_push_framebuffer
|
cogl_push_framebuffer
|
||||||
@ -431,8 +405,6 @@ cogl_color_equal
|
|||||||
<TITLE>Vertex Buffers</TITLE>
|
<TITLE>Vertex Buffers</TITLE>
|
||||||
cogl_vertex_buffer_new
|
cogl_vertex_buffer_new
|
||||||
cogl_vertex_buffer_get_n_vertices
|
cogl_vertex_buffer_get_n_vertices
|
||||||
cogl_vertex_buffer_ref
|
|
||||||
cogl_vertex_buffer_unref
|
|
||||||
cogl_vertex_buffer_add
|
cogl_vertex_buffer_add
|
||||||
cogl_vertex_buffer_delete
|
cogl_vertex_buffer_delete
|
||||||
cogl_vertex_buffer_submit
|
cogl_vertex_buffer_submit
|
||||||
@ -476,8 +448,6 @@ cogl_matrix_get_inverse
|
|||||||
<TITLE>Materials</TITLE>
|
<TITLE>Materials</TITLE>
|
||||||
cogl_material_new
|
cogl_material_new
|
||||||
cogl_material_copy
|
cogl_material_copy
|
||||||
cogl_material_ref
|
|
||||||
cogl_material_unref
|
|
||||||
cogl_is_material
|
cogl_is_material
|
||||||
cogl_material_set_color
|
cogl_material_set_color
|
||||||
cogl_material_set_color4ub
|
cogl_material_set_color4ub
|
||||||
@ -509,7 +479,6 @@ cogl_material_set_layer_combine_constant
|
|||||||
cogl_material_set_layer_matrix
|
cogl_material_set_layer_matrix
|
||||||
cogl_material_set_layer_point_sprite_coords_enabled
|
cogl_material_set_layer_point_sprite_coords_enabled
|
||||||
cogl_material_get_layer_point_sprite_coords_enabled
|
cogl_material_get_layer_point_sprite_coords_enabled
|
||||||
cogl_material_get_layers
|
|
||||||
cogl_material_get_n_layers
|
cogl_material_get_n_layers
|
||||||
CoglMaterialFilter
|
CoglMaterialFilter
|
||||||
cogl_material_set_layer_filters
|
cogl_material_set_layer_filters
|
||||||
@ -581,3 +550,71 @@ cogl_vector3_cross_product
|
|||||||
cogl_vector3_dot_product
|
cogl_vector3_dot_product
|
||||||
cogl_vector3_distance
|
cogl_vector3_distance
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>cogl-deprecated</FILE>
|
||||||
|
<TITLE>General API (Deprecated)</TITLE>
|
||||||
|
cogl_check_extension
|
||||||
|
cogl_viewport
|
||||||
|
|
||||||
|
cogl_get_bitmasks
|
||||||
|
|
||||||
|
cogl_set_depth_test_enabled
|
||||||
|
cogl_get_depth_test_enabled
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>cogl-clipping-deprecated</FILE>
|
||||||
|
<TITLE>Clipping (Deprecated)</TITLE>
|
||||||
|
cogl_clip_push
|
||||||
|
cogl_clip_push_window_rect
|
||||||
|
cogl_clip_ensure
|
||||||
|
cogl_clip_stack_save
|
||||||
|
cogl_clip_stack_restore
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>cogl-texture-deprecated</FILE>
|
||||||
|
<TITLE>Textures (Deprecated)</TITLE>
|
||||||
|
cogl_texture_ref
|
||||||
|
cogl_texture_unref
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>cogl-material-deprecated</FILE>
|
||||||
|
<TITLE>Materials (Deprecated)</TITLE>
|
||||||
|
cogl_material_ref
|
||||||
|
cogl_material_unref
|
||||||
|
cogl_material_get_layers
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>cogl-vertex-buffer-deprecated</FILE>
|
||||||
|
<TITLE>Vertex Buffers (Deprecated)</TITLE>
|
||||||
|
cogl_vertex_buffer_ref
|
||||||
|
cogl_vertex_buffer_unref
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>cogl-shaders-deprecated</FILE>
|
||||||
|
<TITLE>Shaders and Programmable Pipeline (Deprecated)</TITLE>
|
||||||
|
cogl_shader_ref
|
||||||
|
cogl_shader_unref
|
||||||
|
|
||||||
|
<SUBSECTION>
|
||||||
|
cogl_program_ref
|
||||||
|
cogl_program_unref
|
||||||
|
cogl_program_use
|
||||||
|
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-deprecated</FILE>
|
||||||
|
<TITLE>Offscreen Buffers (Deprecated)</TITLE>
|
||||||
|
cogl_offscreen_ref
|
||||||
|
cogl_offscreen_unref
|
||||||
|
</SECTION>
|
||||||
|
Loading…
Reference in New Issue
Block a user