mirror of
https://github.com/moparisthebest/Simba
synced 2024-11-23 09:42:20 -05:00
Colour Conversion, Bitmaps documentation.
This commit is contained in:
parent
522973fdfa
commit
1d17f75796
@ -1,8 +1,8 @@
|
|||||||
|
|
||||||
.PHONY: default clean
|
.PHONY: default clean
|
||||||
|
|
||||||
docunits := os_linux dtm mufasatypes bitmaps
|
docunits := os_linux dtm mufasatypes bitmaps colour_conv
|
||||||
coreunits := os_linux dtm mufasatypes bitmaps
|
coreunits := os_linux dtm mufasatypes bitmaps colour_conv
|
||||||
|
|
||||||
default:
|
default:
|
||||||
|
|
||||||
|
@ -90,6 +90,18 @@
|
|||||||
<element name="ArrDataToRawImage">
|
<element name="ArrDataToRawImage">
|
||||||
<short>Create a TRawImage from passed pixel data.</short>
|
<short>Create a TRawImage from passed pixel data.</short>
|
||||||
</element>
|
</element>
|
||||||
|
<short>The MML bitmap unit</short>
|
||||||
|
<descr>Contains the TMufasaClass and a class that manages an array of TMufasaBitmaps.</descr>
|
||||||
|
<element name="TMBitmaps">
|
||||||
|
<short>Manages TMufasaBitmaps in an array.</short>
|
||||||
|
</element>
|
||||||
|
<element name="RGBToBGR">
|
||||||
|
<short>Function to convert RGB to BGR.</short>
|
||||||
|
<descr>The function is inline so there won't be any function calling overhead.</descr>
|
||||||
|
</element>
|
||||||
|
<element name="TMufasaBitmap.Rectangle">
|
||||||
|
<short>Fill a rectangle with a specific colour.</short>
|
||||||
|
</element>
|
||||||
</module>
|
</module>
|
||||||
</package>
|
</package>
|
||||||
</fpdoc-descriptions>
|
</fpdoc-descriptions>
|
||||||
|
45
LazDoc/colour_conv.xml
Normal file
45
LazDoc/colour_conv.xml
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<fpdoc-descriptions>
|
||||||
|
<package name="Simba">
|
||||||
|
<module name="colour_conv">
|
||||||
|
<element name="RGBtoColor">
|
||||||
|
<short>Convert R, G, B to a Win32 Colour.</short>
|
||||||
|
</element>
|
||||||
|
<element name="ColorToRGB">
|
||||||
|
<short>Convert a Win32 colour to RGB.</short>
|
||||||
|
</element>
|
||||||
|
<element name="RGBToXYZ">
|
||||||
|
<short>Convert R, G, B to X, Y, Z.</short>
|
||||||
|
</element>
|
||||||
|
<element name="XYZToRGB">
|
||||||
|
<short>Convert X, Y, Z to R, G, B.</short>
|
||||||
|
</element>
|
||||||
|
<element name="RGBToHSL">
|
||||||
|
<short>Convert R, G, B to H, S, L.</short>
|
||||||
|
<descr>This function multiplies the H, S, L values returned by 100.</descr>
|
||||||
|
</element>
|
||||||
|
<element name="HSLtoRGB">
|
||||||
|
<short>Convert H, S, L to R, G, B.</short>
|
||||||
|
</element>
|
||||||
|
<element name="RGBToHSLNonFixed">
|
||||||
|
<short>Convert R, G, B to H, S, L.</short>
|
||||||
|
<descr>This function does not multiply the returned H, S, L by 100.</descr>
|
||||||
|
</element>
|
||||||
|
<element name="ColorToHSL">
|
||||||
|
<short>Convert win32 colour to H, S, L.</short>
|
||||||
|
</element>
|
||||||
|
<element name="ColorToXYZ">
|
||||||
|
<short>Convert Win32 colour to X, Y, Z.</short>
|
||||||
|
</element>
|
||||||
|
<element name="HSLToColor">
|
||||||
|
<short>Convert H, S, L to win32 colour.</short>
|
||||||
|
</element>
|
||||||
|
<element name="XYZToColor">
|
||||||
|
<short>Convert X, Y, Z to win32 colour.</short>
|
||||||
|
</element>
|
||||||
|
<element name="BGRToRGB">
|
||||||
|
<short>Swizzle B, G, R to R, G, B.</short>
|
||||||
|
</element>
|
||||||
|
</module>
|
||||||
|
</package>
|
||||||
|
</fpdoc-descriptions>
|
Loading…
Reference in New Issue
Block a user