From 8150292879625eacc3d36273eeaa56fadbb3a43d Mon Sep 17 00:00:00 2001 From: Robert Bragg Date: Thu, 23 Sep 2010 15:45:27 +0100 Subject: [PATCH] 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. --- doc/reference/cogl/cogl-docs.xml.in | 28 ++++++++ doc/reference/cogl/cogl-sections.txt | 99 +++++++++++++++++++--------- 2 files changed, 96 insertions(+), 31 deletions(-) diff --git a/doc/reference/cogl/cogl-docs.xml.in b/doc/reference/cogl/cogl-docs.xml.in index aa53520ca..01d70adc9 100644 --- a/doc/reference/cogl/cogl-docs.xml.in +++ b/doc/reference/cogl/cogl-docs.xml.in @@ -98,6 +98,34 @@ + + Cogl deprecated API + +
+ + About the deprecated API + + 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. + +
+ + + + + + + + + + + Glossaries diff --git a/doc/reference/cogl/cogl-sections.txt b/doc/reference/cogl/cogl-sections.txt index ed3d70262..8acacc786 100644 --- a/doc/reference/cogl/cogl-sections.txt +++ b/doc/reference/cogl/cogl-sections.txt @@ -23,7 +23,6 @@ CoglAttributeType CoglFeatureFlags cogl_get_features cogl_features_available -cogl_check_extension cogl_get_proc_address cogl_get_option_group @@ -43,15 +42,11 @@ cogl_get_modelview_matrix cogl_set_modelview_matrix cogl_get_projection_matrix cogl_set_projection_matrix -cogl_viewport cogl_set_viewport cogl_get_viewport 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 @@ -139,13 +134,6 @@ cogl_clip_push_window_rectangle cogl_clip_push_from_path cogl_clip_push_from_path_preserve cogl_clip_pop - - -cogl_clip_push -cogl_clip_push_window_rect -cogl_clip_ensure -cogl_clip_stack_save -cogl_clip_stack_restore
@@ -214,8 +202,6 @@ cogl_texture_new_from_foreign cogl_texture_new_from_bitmap cogl_texture_new_from_sub_texture cogl_is_texture -cogl_texture_ref -cogl_texture_unref cogl_texture_get_width @@ -245,8 +231,6 @@ cogl_is_texture_3d Shaders and Programmable Pipeline CoglShaderType cogl_create_shader -cogl_shader_ref -cogl_shader_unref cogl_is_shader cogl_shader_source cogl_shader_compile @@ -256,31 +240,21 @@ cogl_shader_is_compiled 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_set_uniform_1f cogl_program_set_uniform_1i cogl_program_set_uniform_float cogl_program_set_uniform_int 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
cogl-offscreen Offscreen Buffers cogl_offscreen_new_to_texture -cogl_offscreen_ref -cogl_offscreen_unref cogl_is_offscreen cogl_set_framebuffer cogl_push_framebuffer @@ -431,8 +405,6 @@ cogl_color_equal Vertex Buffers 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 @@ -476,8 +448,6 @@ cogl_matrix_get_inverse Materials cogl_material_new cogl_material_copy -cogl_material_ref -cogl_material_unref cogl_is_material cogl_material_set_color cogl_material_set_color4ub @@ -509,7 +479,6 @@ cogl_material_set_layer_combine_constant cogl_material_set_layer_matrix cogl_material_set_layer_point_sprite_coords_enabled cogl_material_get_layer_point_sprite_coords_enabled -cogl_material_get_layers cogl_material_get_n_layers CoglMaterialFilter cogl_material_set_layer_filters @@ -581,3 +550,71 @@ cogl_vector3_cross_product cogl_vector3_dot_product cogl_vector3_distance
+ +
+cogl-deprecated +General API (Deprecated) +cogl_check_extension +cogl_viewport + +cogl_get_bitmasks + +cogl_set_depth_test_enabled +cogl_get_depth_test_enabled +
+ +
+cogl-clipping-deprecated +Clipping (Deprecated) +cogl_clip_push +cogl_clip_push_window_rect +cogl_clip_ensure +cogl_clip_stack_save +cogl_clip_stack_restore +
+ +
+cogl-texture-deprecated +Textures (Deprecated) +cogl_texture_ref +cogl_texture_unref +
+ +
+cogl-material-deprecated +Materials (Deprecated) +cogl_material_ref +cogl_material_unref +cogl_material_get_layers +
+ +
+cogl-vertex-buffer-deprecated +Vertex Buffers (Deprecated) +cogl_vertex_buffer_ref +cogl_vertex_buffer_unref +
+ +
+cogl-shaders-deprecated +Shaders and Programmable Pipeline (Deprecated) +cogl_shader_ref +cogl_shader_unref + + +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 +
+ +
+cogl-offscreen-deprecated +Offscreen Buffers (Deprecated) +cogl_offscreen_ref +cogl_offscreen_unref +