Y01 Improved Package documentation canvas
authorAnton Epple <toni.epple@eppleton.de>
Tue, 18 Feb 2014 11:01:08 +0100
branchcanvas
changeset 147536dce152ef80
parent 1452 716529430700
Y01 Improved Package documentation
javaquery/canvas/src/main/resources/net/java/html/canvas/package.html
javaquery/canvas/src/main/resources/net/java/html/canvas/spi/package.html
     1.1 --- a/javaquery/canvas/src/main/resources/net/java/html/canvas/package.html	Wed Feb 12 16:12:15 2014 +0100
     1.2 +++ b/javaquery/canvas/src/main/resources/net/java/html/canvas/package.html	Tue Feb 18 11:01:08 2014 +0100
     1.3 @@ -20,5 +20,16 @@
     1.4  <html>
     1.5      <body>
     1.6          Universal, flexible, capable, effective, highly efficient Canvas API for any device on the planet (and beyond). 
     1.7 +        The purpose of this API is to create a common interface for drawing to a canvas using Java. Currently there are implementations for JavaFX Canvas and for
     1.8 +        HTML 5 Canvas. You can choose your implementation depending on the availability on your target platform and performance
     1.9 +        requirements.
    1.10 +        
    1.11 +        The entry point is the GraphicsUtils class. It gives you access to the GraphicsContext that you can use to draw.
    1.12 +        Currently you need to pass in a GraphicsEnvironment:
    1.13 +        // JavaFX implementation available here https://github.com/eppleton/FXGameEngine
    1.14 +        GraphicsContext gc = GraphicsUtil.create(new JavaFXGraphicsEnvironment()); 
    1.15 +        
    1.16 +   
    1.17 +       
    1.18      </body>
    1.19  </html>
     2.1 --- a/javaquery/canvas/src/main/resources/net/java/html/canvas/spi/package.html	Wed Feb 12 16:12:15 2014 +0100
     2.2 +++ b/javaquery/canvas/src/main/resources/net/java/html/canvas/spi/package.html	Tue Feb 18 11:01:08 2014 +0100
     2.3 @@ -19,6 +19,9 @@
     2.4  -->
     2.5  <html>
     2.6      <body>
     2.7 -        SPI for enabling the Canvas API on different platforms.
     2.8 +        SPI for enabling the Canvas API on different platforms. Currently there are 
     2.9 +        implementations for HTML5 Canvas and JavaFX Canvas. If you want to create another 
    2.10 +        implementation, e.g. because you expect performance gains, or HTML5 and JavaFX
    2.11 +        are not available on your platform, you need to implement one interface, GraphicsEnvironment.
    2.12      </body>
    2.13  </html>