writing RasterEncoder docs

git-svn-id: svn://ultimatepp.org/upp/trunk@1471 f0d560ea-af0d-0410-9eb7-867de7ffcac7
This commit is contained in:
cxl 2009-08-03 15:01:30 +00:00
parent c05a4c518f
commit 4f5b017c0c
3 changed files with 174 additions and 0 deletions

View file

@ -0,0 +1,162 @@
topic "";
[2 $$0,0#00000000000000000000000000000000:Default]
[i448;a25;kKO9;2 $$1,0#37138531426314131252341829483380:class]
[l288;2 $$2,2#27521748481378242620020725143825:desc]
[0 $$3,0#96390100711032703541132217272105:end]
[H6;0 $$4,0#05600065144404261032431302351956:begin]
[i448;a25;kKO9;2 $$5,0#37138531426314131252341829483370:item]
[l288;a4;*@5;1 $$6,6#70004532496200323422659154056402:requirement]
[l288;i1121;b17;O9;~~~.1408;2 $$7,0#10431211400427159095818037425705:param]
[i448;b42;O9;2 $$8,8#61672508125594000341940100500538:tparam]
[b42;2 $$9,9#13035079074754324216151401829390:normal]
[{_}%EN-US
[ {{10000@(113.42.0) [s0; [*@7;4 Title]]}}&]
[s1;@(0.0.255)3%- &]
[s1;:RasterEncoder`:`:class:%- [@(0.0.255)3 class][3 _][*3 RasterEncoder]&]
[s2; &]
[s3;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Protected Members List]]}}&]
[s4;%- &]
[s5;:RasterEncoder`:`:format:%- [_^RasterFormat^ RasterFormat]_[* format]&]
[s2; &]
[s3;%- &]
[s4;%- &]
[s5;:RasterEncoder`:`:SetLine`(RGBA`*`):%- [@(0.0.255) void]_[* SetLine]([_^RGBA^ RGBA]_`*[*@3 `_
line])&]
[s2; [%-*@3 `_line].&]
[s3; &]
[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&]
[s0; &]
[s4; &]
[s5;:RasterEncoder`:`:GetPaletteCount`(`):%- [@(0.0.255) virtual] [@(0.0.255) int]_[* GetPa
letteCount]()&]
[s2; Returns the number of colors in the palette (or zero).&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Start`(Size`):%- [@(0.0.255) virtual] [@(0.0.255) void]_[* Start]([_^Size^ S
ize]_[*@3 sz])_`=_[@3 0]&]
[s2; Called at the start of processing [%-*@3 sz].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:WriteLineRaw`(const byte`*`):%- [@(0.0.255) virtual]
[@(0.0.255) void]_[* WriteLineRaw]([@(0.0.255) const]_[_^byte^ byte]_`*[*@3 data])_`=_[@3 0]&]
[s2; [%-*@3 data].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:WriteLine`(`):%- [@(0.0.255) void]_[* WriteLine]()&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:WriteLine`(const RGBA`*`):%- [@(0.0.255) void]_[* WriteLine]([@(0.0.255) c
onst]_[_^RGBA^ RGBA]_`*[*@3 s])&]
[s2; [%-*@3 s].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetFormat`(`)const:%- [@(0.0.255) const]_[_^RasterFormat^ RasterFor
mat][@(0.0.255) `&]_[* GetFormat]()_[@(0.0.255) const]&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetPalette`(`):%- [@(0.0.255) const]_[_^RGBA^ RGBA]_`*[* GetPalette](
)&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetPaletteCv`(`):%- [@(0.0.255) const]_[_^PaletteCv^ PaletteCv]_`*[* G
etPaletteCv]()&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:operator RGBA`*`(`):%- [@(0.0.255) operator]_RGBA_`*()&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:operator`~`(`):%- [_^RGBA^ RGBA]_`*[* operator`~]()&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetSize`(`)const:%- [_^Size^ Size]_[* GetSize]()_[@(0.0.255) const]&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetWidth`(`)const:%- [@(0.0.255) int]_[* GetWidth]()_[@(0.0.255) cons
t]&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetHeight`(`)const:%- [@(0.0.255) int]_[* GetHeight]()_[@(0.0.255) co
nst]&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:SetHotSpot`(Point`):%- [@(0.0.255) void]_[* SetHotSpot]([_^Point^ Poi
nt]_[*@3 p])&]
[s2; [%-*@3 p].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetHotSpot`(`)const:%- [_^Point^ Point]_[* GetHotSpot]()_[@(0.0.255) c
onst]&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:SetDots`(Size`):%- [@(0.0.255) void]_[* SetDots]([_^Size^ Size]_[*@3 `_
dots])&]
[s2; [%-*@3 `_dots].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:GetDots`(`)const:%- [_^Size^ Size]_[* GetDots]()_[@(0.0.255) const]&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:SetPalette`(const RGBA`*`):%- [@(0.0.255) void]_[* SetPalette]([@(0.0.255) c
onst]_[_^RGBA^ RGBA]_`*[*@3 palette])&]
[s2; [%-*@3 palette].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:SetPalette`(Raster`&`):%- [@(0.0.255) void]_[* SetPalette]([_^Raster^ R
aster][@(0.0.255) `&]_[*@3 pal`_raster])&]
[s2; [%-*@3 pal`_raster].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Create`(Size`):%- [@(0.0.255) void]_[* Create]([_^Size^ Size]_[*@3 sz])
&]
[s2; [%-*@3 sz].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Create`(int`,int`):%- [@(0.0.255) void]_[* Create]([@(0.0.255) int]_[*@3 c
x], [@(0.0.255) int]_[*@3 cy])&]
[s2; [%-*@3 cx] [%-*@3 cy].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Create`(Size`,const RGBA`*`):%- [@(0.0.255) void]_[* Create]([_^Size^ S
ize]_[*@3 sz], [@(0.0.255) const]_[_^RGBA^ RGBA]_`*[*@3 palette])&]
[s2; [%-*@3 sz] [%-*@3 palette].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Create`(int`,int`,const RGBA`*`):%- [@(0.0.255) void]_[* Create]([@(0.0.255) i
nt]_[*@3 cx], [@(0.0.255) int]_[*@3 cy], [@(0.0.255) const]_[_^RGBA^ RGBA]_`*[*@3 palette])&]
[s2; [%-*@3 cx] [%-*@3 cy] [%-*@3 palette].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Create`(Size`,Raster`&`):%- [@(0.0.255) void]_[* Create]([_^Size^ Siz
e]_[*@3 sz], [_^Raster^ Raster][@(0.0.255) `&]_[*@3 pal`_raster])&]
[s2; [%-*@3 sz] [%-*@3 pal`_raster].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:Create`(int`,int`,Raster`&`):%- [@(0.0.255) void]_[* Create]([@(0.0.255) i
nt]_[*@3 cx], [@(0.0.255) int]_[*@3 cy], [_^Raster^ Raster][@(0.0.255) `&]_[*@3 pal`_raster])
&]
[s2; [%-*@3 cx] [%-*@3 cy] [%-*@3 pal`_raster].&]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:RasterEncoder`(`):%- [* RasterEncoder]()&]
[s2; &]
[s3; &]
[s4; &]
[s5;:RasterEncoder`:`:`~RasterEncoder`(`):%- [@(0.0.255) `~][* RasterEncoder]()&]
[s2; &]
[s3; &]
[s0;%- &]
[s0;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Constructor detail]]}}&]
[s0; ]

View file

@ -0,0 +1,8 @@
TITLE("")
COMPRESSED
120,156,173,88,107,79,227,70,20,253,43,35,177,160,36,10,209,188,252,138,85,137,150,221,5,169,219,22,145,86,251,193,114,108,147,12,96,53,216,169,61,217,22,16,249,237,189,227,71,112,18,39,113,66,16,50,102,230,62,206,185,175,25,217,161,232,211,39,220,197,39,120,199,79,255,179,184,15,102,19,233,58,33,231,166,29,80,205,254,251,215,63,44,91,233,19,208,103,6,97,166,198,8,167,58,60,8,35,84,163,140,19,147,90,220,100,204,196,253,209,36,72,83,215,153,80,211,204,148,104,151,158,80,67,163,196,224,38,55,9,51,76,10,186,20,99,138,13,170,17,206,76,170,245,199,34,29,185,14,6,113,6,62,44,157,89,152,96,108,16,130,25,53,48,211,56,33,140,130,9,106,80,130,181,190,136,198,174,115,173,219,74,129,43,82,154,14,208,117,176,198,57,6,235,74,141,51,194,48,101,26,177,52,189,127,39,30,194,168,142,146,182,147,146,129,251,161,20,79,5,163,128,219,157,11,205,38,160,170,119,245,19,3,220,114,13,156,89,138,17,3,53,74,117,205,34,
26,7,72,28,211,126,34,254,153,133,137,120,18,145,44,44,132,132,80,98,223,17,195,6,8,243,249,188,71,56,206,35,101,0,22,130,1,55,37,176,6,60,12,162,89,216,210,76,98,98,102,112,170,25,64,125,26,36,193,83,193,228,142,83,187,224,97,118,205,19,157,232,16,81,108,2,126,205,2,3,24,72,192,95,8,164,6,191,204,236,203,66,89,233,41,37,171,107,157,64,144,152,134,13,11,27,220,208,56,48,161,68,39,16,72,172,248,67,26,250,81,156,60,5,19,215,121,245,222,78,191,252,126,254,215,0,57,232,245,149,168,90,185,104,65,90,122,156,246,112,27,57,41,182,145,211,185,48,108,142,254,12,229,68,184,238,219,219,153,235,164,196,190,104,225,30,238,1,168,54,59,61,71,249,90,255,54,72,165,72,190,68,163,120,44,18,191,239,231,117,211,7,1,167,34,143,138,106,98,200,115,157,14,67,75,90,174,50,69,237,204,34,179,115,211,37,180,175,45,66,205,246,85,246,188,32,37,58,116,147,196,82,140,164,24,163,223,196,211,157,72,82,244,45,76,101,
9,149,23,70,82,173,6,223,189,138,131,204,0,122,195,124,247,107,182,52,68,213,255,92,15,220,228,178,117,248,182,251,24,8,249,45,140,132,223,186,189,250,229,103,191,227,183,87,226,129,126,196,225,56,243,80,72,186,45,5,6,132,1,4,60,93,207,239,64,14,24,242,189,137,218,109,23,8,144,115,122,94,89,238,229,136,154,196,107,118,55,9,71,16,44,249,24,143,151,98,133,237,130,206,70,50,87,66,222,4,19,33,165,184,140,103,145,244,91,53,116,194,68,206,160,184,150,22,195,40,15,226,138,190,219,42,217,220,10,57,75,162,20,201,71,129,162,153,74,35,138,239,209,40,158,196,144,207,48,202,214,167,185,38,106,197,9,122,17,73,220,174,112,222,6,122,32,131,4,160,14,194,23,209,16,238,123,74,148,106,150,16,165,61,68,234,169,54,32,238,233,139,219,246,252,159,60,7,222,113,89,22,151,193,100,2,133,24,200,12,112,170,180,21,143,105,18,143,68,154,134,209,67,153,53,208,110,136,254,123,2,163,74,213,197,109,240,175,223,26,197,81,42,209,221,179,
20,181,165,180,149,76,213,18,112,170,136,100,86,65,198,27,42,203,195,204,254,162,238,198,129,12,106,168,150,76,178,237,125,185,212,22,206,26,206,247,242,216,219,124,30,167,157,45,87,113,85,31,143,154,62,76,215,90,48,109,202,31,202,63,159,40,138,127,230,100,21,89,197,243,230,113,84,85,240,207,202,198,42,54,91,109,111,221,224,94,97,124,111,210,186,52,109,142,77,165,187,247,205,92,101,46,252,216,238,116,33,54,68,139,215,53,247,176,180,39,128,120,42,146,64,194,96,41,74,166,6,67,41,226,122,74,6,92,30,232,194,159,47,172,215,196,240,93,234,128,24,102,35,110,169,180,86,7,23,42,164,142,83,38,223,195,177,124,220,88,203,149,161,159,9,30,199,231,181,8,31,30,55,55,80,197,105,46,121,4,175,112,48,95,199,114,48,141,193,237,77,12,30,182,31,226,133,108,118,108,100,226,80,170,113,129,11,166,197,116,109,126,76,247,152,31,11,32,203,89,94,245,131,174,42,56,142,17,128,207,177,76,55,158,161,21,242,74,174,254,192,244,189,177,218,91,
191,191,100,203,205,35,144,35,217,85,228,57,142,99,48,95,204,194,134,103,202,160,50,5,27,31,42,197,221,102,189,52,138,245,166,87,157,10,220,124,211,63,107,10,181,60,114,202,195,166,230,152,201,1,249,94,146,11,212,128,93,236,53,4,124,153,136,64,129,221,81,88,185,216,230,139,216,234,129,220,248,118,85,250,87,77,221,221,222,217,11,12,235,211,6,92,142,254,115,187,117,131,72,109,61,175,1,4,233,197,235,243,65,177,234,54,172,198,29,145,235,54,60,219,183,148,40,88,57,176,90,215,130,191,55,169,3,82,113,4,198,203,217,251,32,249,60,155,13,154,117,119,38,63,222,193,203,185,60,180,153,223,243,185,15,173,195,114,249,113,206,27,179,185,47,253,229,133,242,142,215,89,249,192,177,231,173,206,159,215,155,173,178,156,187,141,188,224,242,51,5,110,246,97,229,82,245,70,50,27,169,107,241,88,200,32,156,84,62,20,184,255,3,81,208,29,32,

View file

@ -14,3 +14,7 @@ TOPIC("PaintRect$en-us")
#include "PaintRect$en-us.tppi"
END_TOPIC
TOPIC("RasterEncoder$en-us")
#include "RasterEncoder$en-us.tppi"
END_TOPIC