net.dzzd.access
Interface IRender2D

All Superinterfaces:
IRemoveSceneObjectConsumer, IRender, IRender2DMode
All Known Subinterfaces:
IRender3D

public interface IRender2D
extends IRender, IRender2DMode

Used for accessing to a Render2D.

Version:
1.0
Author:
Bruno Augier

Method Summary
 java.awt.Canvas getCanvas()
          Gets this Render2D canvas.
 IDirectInput getDirectInput()
          Gets this Render2D directInput.
 int getHeight()
          Gets this Render2D height
 java.lang.String getImplementationName()
          Gets this Render2D implementation name.
 IRender2DMode getRender2DMode()
          Gets the RenderMode interface for this Render2D.
 int getWidth()
          Gets this Render2D width
 boolean isPixelUpdateEnabled()
          Gets the pixelUpdateEnabled flag .
 boolean isScreenUpdateEnabled()
          Gets the screenUpdateEnabled flag .
 void renderScene2D(IScene2D scene)
          Render the given Scene2D.
 void setAntialiasLevel(int level)
          Sets antialias level.
 void setCursor(java.awt.Cursor cursor)
          Sets this Render2D cursor
 void setPixelUpdateEnabled(boolean flag)
          Sets the pixelUpdateEnabled flag .
 void setScreenUpdateEnabled(boolean flag)
          Sets the screenUpdateEnabled flag .
 void setSize(int viewPixelWidth, int viewPixelHeight)
          Sets this Render2D size .
 void setSize(int viewPixelWidth, int viewPixelHeight, int maxAntialias)
          Sets this Render2D size and its max antialias level.
 
Methods inherited from interface net.dzzd.access.IRemoveSceneObjectConsumer
clearScene, removeSceneObject
 
Methods inherited from interface net.dzzd.access.IRender2DMode
disableRender2DMode, enableRender2DMode, getRender2DModeFlags, setRender2DModeFlags
 

Method Detail

getCanvas

public java.awt.Canvas getCanvas()
Gets this Render2D canvas.

Returns:
this Render2D canvas

setSize

public void setSize(int viewPixelWidth,
                    int viewPixelHeight,
                    int maxAntialias)
Sets this Render2D size and its max antialias level.

Parameters:
viewPixelWidth - width expressed in pixels
viewPixelHeight - height expressed in pixels
maxAntialias - maximum antialias : (0-7)

setSize

public void setSize(int viewPixelWidth,
                    int viewPixelHeight)
Sets this Render2D size .

Parameters:
viewPixelWidth - width expressed in pixels
viewPixelHeight - height expressed in pixels

setAntialiasLevel

public void setAntialiasLevel(int level)
Sets antialias level.

Parameters:
level - antialias level : (0-7)

getWidth

public int getWidth()
Gets this Render2D width

Returns:
width expressed in pixel

getHeight

public int getHeight()
Gets this Render2D height

Returns:
height expressed in pixel

setCursor

public void setCursor(java.awt.Cursor cursor)
Sets this Render2D cursor

Parameters:
cursor - cursor object ot use as cursor when mouse over this Render2D canvas expressed in pixel

renderScene2D

public void renderScene2D(IScene2D scene)
Render the given Scene2D.

Parameters:
scene - Scene2D to render.

getRender2DMode

public IRender2DMode getRender2DMode()
Gets the RenderMode interface for this Render2D. RenderMode is used to enable/disable rendering features : lighting,texture,mipmapping.

Specified by:
getRender2DMode in interface IRender2DMode
Returns:
RenderMode interface to control this Render2D rendering.

getImplementationName

public java.lang.String getImplementationName()
Gets this Render2D implementation name.

Returns:
name of the implementation used for this Render2D.

getDirectInput

public IDirectInput getDirectInput()
Gets this Render2D directInput.

Returns:
a directInput interface to read mouse and keyboard informations at anytime.

isScreenUpdateEnabled

public boolean isScreenUpdateEnabled()
Gets the screenUpdateEnabled flag .
set this flag to false to disable onscreen rendering.

Returns:
screenUpdateEnabled flag

setScreenUpdateEnabled

public void setScreenUpdateEnabled(boolean flag)
Sets the screenUpdateEnabled flag .
set this flag to false to disable onscreen rendering.

Parameters:
flag - screenUpdateEnabled flag

isPixelUpdateEnabled

public boolean isPixelUpdateEnabled()
Gets the pixelUpdateEnabled flag .
set this flag to false to disable pixels rendering.

Returns:
pixelUpdateEnabled flag

setPixelUpdateEnabled

public void setPixelUpdateEnabled(boolean flag)
Sets the pixelUpdateEnabled flag .
set this flag to false to disable pixels rendering.

Parameters:
flag - pixelUpdateEnabled flag