Re: [AD] A few minor changes to the docs

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


> + In the "Windows specifics" section, it mentions that in order to use a
> custom application icon, the executable must contain an icon called
> "allegro icon". What the docs do not mention is how to create one using
> MSVC. Here's how this would be done.
> [...MSVC specific infos...]

I don't think we have to document any compiler-specific methods in the 
Allegro manual. So I've only added:

"See the manual of your compiler for a method to create an ICON resource, or 
use the wfixicon utility from the tools/win directory."

(I hadn't realized that wfixicon was not mentioned in the docs at all).

> + In the docs for set_color_depth(), it's "see also" section should point
> to "bitmap_color_depth()" so that the current colour depth can be found.

Done only on the 4.0.x branch (the 4.1.x branch has got get_color_depth).

> + In the docs for bitmap_color_depth(), it should mention that you can
> pass in 'screen' as the bitmap paramater to get the colour-depth of the
> currently used graphics-mode.

Likewise.

> I have also optimised the hsv_to_rgb() function and have written an
> improved EXRGBHSV example that adds changing colour-bars underneath the
> sliders so you can see how the colours will be changed by changing the
> sliders. Should I post this here as well?

Sure.

Thanks for your contribution!

-- 
Eric Botcazou
Index: docs/src/allegro._tx
===================================================================
RCS file: /cvsroot/alleg/allegro/docs/src/allegro._tx,v
retrieving revision 1.21.2.29
diff -u -r1.21.2.29 allegro._tx
--- docs/src/allegro._tx	7 Apr 2003 20:52:10 -0000	1.21.2.29
+++ docs/src/allegro._tx	14 Apr 2003 12:26:21 -0000
@@ -2191,10 +2191,12 @@
 Graphics modes
 
 @@void @set_color_depth(int depth);
-@domain.hid set_gfx_mode, set_color_conversion, makecol, getr
+@xref set_gfx_mode, set_color_conversion, makecol, getr, bitmap_color_depth
    Sets the pixel format to be used by subsequent calls to set_gfx_mode() 
    and create_bitmap(). Valid depths are 8 (the default), 15, 16, 24, and 32 
-   bits.
+   bits. Note that you can retrieve the pixel format currently in use by
+   calling bitmap_color_depth() on the 'screen' bitmap, once a graphics mode
+   has been set.
 
 @@void @request_refresh_rate(int rate);
 @xref set_gfx_mode, get_refresh_rate
@@ -2761,6 +2763,9 @@
 @@int @bitmap_color_depth(BITMAP *bmp);
 @xref set_color_depth, bitmap_mask_color
    Returns the color depth of the specified bitmap (8, 15, 16, 24, or 32).
+   Note that calling it on the 'screen' bitmap will return the pixel format
+   currently in use, as specified by the latest call to set_color_depth(),
+   once a graphics mode has been set.
 
 @@int @bitmap_mask_color(BITMAP *bmp);
 @xref MASK_COLOR_8, set_color_depth, bitmap_color_depth
@@ -7784,8 +7789,10 @@
 
 When creating the main window, Allegro searches the executable for an ICON 
 resource named "allegro_icon". If it is present, Allegro automatically 
-loads it and uses it as its application icon. Otherwise, Allegro uses the 
-default IDI_APPLICATION icon.
+loads it and uses it as its application icon; otherwise, Allegro uses the 
+default IDI_APPLICATION icon. See the manual of your compiler for a method 
+to create an ICON resource, or use the wfixicon utility from the tools/win 
+directory.
 
 DirectX requires that system and video bitmaps (including the screen) be 
 locked before you can draw onto them. This will be done automatically, but 


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/