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

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/08/22 00:13:58

Modified files:
        .              : ChangeLog 
        server         : gnash.h 

Log message:
        * server/gnash.h: doxygen comments on render_handler struct

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.670&r2=1.671
http://cvs.savannah.gnu.org/viewcvs/gnash/server/gnash.h?cvsroot=gnash&r1=1.38&r2=1.39

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.670
retrieving revision 1.671
diff -u -b -r1.670 -r1.671
--- ChangeLog   21 Aug 2006 23:42:19 -0000      1.670
+++ ChangeLog   22 Aug 2006 00:13:58 -0000      1.671
@@ -1,5 +1,6 @@
 2006-08-21 Sandro Santilli  <address@hidden>
 
+       * server/gnash.h: doxygen comments on render_handler struct
        * utilities/processor.cpp: don't show -vp and -va options if
          verbose parsing and action is not compiled in (bug #17367).
        * gui/gnash.cpp: fix -vp when VERBOSE_ACTION is undefined (bug #17367).

Index: server/gnash.h
===================================================================
RCS file: /sources/gnash/gnash/server/gnash.h,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -b -r1.38 -r1.39
--- server/gnash.h      21 Aug 2006 22:24:25 -0000      1.38
+++ server/gnash.h      22 Aug 2006 00:13:58 -0000      1.39
@@ -670,16 +670,48 @@
        virtual ~render_handler() {}
 
        // Your handler should return these with a ref-count of 0.  (@@ is that 
the right policy?)
-       virtual bitmap_info*    create_bitmap_info_empty() = 0; // used when 
DO_NOT_LOAD_BITMAPS is set
+
+       /// \brief
+       /// 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.
+       ///
+       virtual bitmap_info*    create_bitmap_info_empty() = 0; 
+
+       /// \brief
+       ///  Create a bitmap_info so that it contains an alpha texture
+       /// with the given data (1 byte per texel).
+       //
+       /// Munges *data (in order to make mipmaps)!!
+       ///
        virtual bitmap_info*    create_bitmap_info_alpha(int w, int h, unsigned 
char* data) = 0;
+
+       /// \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.
        virtual bitmap_info*    create_bitmap_info_rgb(image::rgb* im) = 0;
+
+       /// \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.
+       ///
        virtual bitmap_info*    create_bitmap_info_rgba(image::rgba* im) = 0;
 
+       /// Delete the given bitmap info struct.
        virtual void    delete_bitmap_info(bitmap_info* bi) = 0;
                
        /// Bracket the displaying of a frame from a movie.
+       //
        /// Fill the background color, and set up default
        /// transforms, etc.
+       ///
        virtual void    begin_display(
                rgba background_color,
                int viewport_x0, int viewport_y0,