.doc Painter documentation

git-svn-id: svn://ultimatepp.org/upp/trunk@11211 f0d560ea-af0d-0410-9eb7-867de7ffcac7
This commit is contained in:
klugier 2017-07-02 15:20:46 +00:00
parent 327715ca7d
commit ac89d58873
2 changed files with 64 additions and 0 deletions

View file

@ -0,0 +1,31 @@
topic "ImagePainter";
[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]
[{_}
[ {{10000@(113.42.0) [s0;%% [*@7;4 ImagePainter]]}}&]
[s3; &]
[s1;:Upp`:`:ImagePainter`:`:class: [@(0.0.255)3 class][3 _][*3 ImagePainter][3 _:_][@(0.0.255)3 p
rivate][3 _][*@3;3 ImageBuffer`_`_][3 , ][@(0.0.255)3 public][3 _][*@3;3 BufferPainter]&]
[s9; ImagePainter is designed converting drawing instructions into
Image. It uses the Painter as a rendering engine to achieve that
goal. So, it could be freely use in terminal application to generate
graphical content.&]
[s3; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Function List]]}}&]
[s0;i448;a25;kKO9;:noref:@(0.0.255) &]
[ {{10000F(128)G(128)@1 [s0;%% [* Public Method List]]}}&]
[s3; &]
[s5;:Upp`:`:ImagePainter`:`:operator Image`(`): [* operator_Image]()&]
[s2;%% Returns Image that is stored in ImagePainter.&]
[s0; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Constructor detail]]}}&]
[s4; &]
[s5;:Upp`:`:ImagePainter`:`:operator Image`(`):* ]]

View file

@ -0,0 +1,33 @@
topic "Painter";
[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]
[{_}
[ {{10000@(113.42.0) [s0;%% [*@7;4 Painter]]}}&]
[s0;@(0.0.255)3 &]
[s0; [@(0.0.255)3 class][3 _][*3 Painter][3 _:_][@(0.0.255)3 public][3 _][*@3;3 Draw]&]
[s9; The [* Painter ]class provides rendering engine to the [* Draw].
It supports all the drawing operation that is supported by that
package. In addition it dosen`'t require any system drawing library
dependency. What makes him very useful in terminal app where
GUI libraries are unnecessary ballast.&]
[s9; &]
[s9; Morover [* Painter] in contrast to painter allows to use much
more powerfull operation like blur effect, rounded shape etc.
It is excelent choice when the general guality of rendering metters.
The good example of that situation is for example two dimension
physics simulation or platformer games.&]
[s3; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Function List]]}}&]
[s0;i448;a25;kKO9;:noref:@(0.0.255) &]
[ {{10000F(128)G(128)@1 [s0;%% [* Public Method List]]}}&]
[s0; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Constructor detail]]}}&]
[s0;%% TODO]]