[Gnash-commit] gnash ChangeLog server/render.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/08/22 21:45:09

Modified files:
        .              : ChangeLog 
        server         : render.h 

Log message:
        doxygen comments

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.681&r2=1.682
http://cvs.savannah.gnu.org/viewcvs/gnash/server/render.h?cvsroot=gnash&r1=1.4&r2=1.5

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.681
retrieving revision 1.682
diff -u -b -r1.681 -r1.682
--- ChangeLog   22 Aug 2006 21:34:22 -0000      1.681
+++ ChangeLog   22 Aug 2006 21:45:09 -0000      1.682
@@ -1,5 +1,6 @@
 2006-08-22 Sandro Santilli  <address@hidden>
 
+       * server/render.h: doxygen comments.
        * libbase/Thread.cpp: removed unused parameter warning.
        * server/as_value.cpp: removed const cast warning.
        * server/font.cpp, server/textformat.cpp:

Index: server/render.h
===================================================================
RCS file: /sources/gnash/gnash/server/render.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- server/render.h     27 Jul 2006 01:47:11 -0000      1.4
+++ server/render.h     22 Aug 2006 21:45:09 -0000      1.5
@@ -28,11 +28,40 @@
        ///
        namespace render
        {
+
+               /// Create a placeholder bitmap_info. 
+               //
+               /// Used when DO_NOT_LOAD_BITMAPS is set; then later on
+               /// the host program can use
+               /// movie_definition::get_bitmap_info_count() and
+               /// movie_definition::get_bitmap_info() to stuff precomputed
+               /// textures into these bitmap infos.
+               ///
                bitmap_info*    create_bitmap_info_empty();
+
+               /// \brief
+               /// Create a bitmap_info so that it contains an alpha texture
+               /// with the given data (1 byte per texel).
                bitmap_info*    create_bitmap_info_alpha(int w, int h,
                                        unsigned char* data);
+
+               /// \brief
+               /// Given an image, returns a pointer to a bitmap_info struct
+               /// that can later be passed to fill_styleX_bitmap(), to set a
+               /// bitmap fill style.
+               ///
                bitmap_info*    create_bitmap_info_rgb(image::rgb* im);
+
+               /// \brief
+               /// Given an image, returns a pointer to a bitmap_info struct
+               /// that can later be passed to fill_style_bitmap(), to set a
+               /// bitmap fill style.
+               //
+               /// This version takes an image with an alpha channel.
+               ///
                bitmap_info*    create_bitmap_info_rgba(image::rgba* im);
+
+               /// Delete the given bitmap info struct.
                void    delete_bitmap_info(bitmap_info* bi);
 
                /// \brief
@@ -47,7 +76,8 @@
                        float x0, float x1, float y0, float y1);
                void    end_display();
 
-               // Geometric and color transforms for mesh and line_strip 
rendering.
+               // Geometric and color transforms for mesh
+               // and line_strip rendering.
                void    set_matrix(const matrix& m);
                void    set_cxform(const cxform& cx);
 
@@ -70,14 +100,29 @@
                void    draw_line_strip(const int16_t coords[],
                                int vertex_count);
 
+               /// Don't fill on the {0 == left, 1 == right} side of a path.
                void    fill_style_disable(int fill_side);
+
+               /// Set fill style for the left interior of the shape. 
+               //
+               /// If enable is false, turn off fill for the left interior.
+               ///
                void    fill_style_color(int fill_side, rgba color);
+
                void    fill_style_bitmap(int fill_side, const bitmap_info* bi,
                                const matrix& m,
                                render_handler::bitmap_wrap_mode wm);
 
+               /// Don't draw a line on this path.
                void    line_style_disable();
+
+               /// Set the line style of the shape. 
+               //
+               /// If enable is false, turn off lines for following
+               /// curve segments.
+               ///
                void    line_style_color(rgba color);
+
                void    line_style_width(float width);
 
                void    begin_submit_mask();