Class Index | File Index

Classes


Namespace sandboxe.graphics


Defined in: docbase.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Functions for working with rendering setup and actions.
Method Summary
Method Attributes Method Name and Description
<static>  
sandboxe.graphics.commit()
Forces the rendered scene to be drawn on the screen.
<static>  
sandboxe.graphics.draw(object)
Draws an object to the current display.
<static>  
sandboxe.graphics.getCamera2d()
Returns the current 2d camera object.
<static>  
sandboxe.graphics.getCamera3d()
Returns the current 3d camera object.
<static>  
sandboxe.graphics.getDrawEachFrame()
whether each frame is being drawn, updated, and swapped automatically by sandboxe or not.
<static>  
sandboxe.graphics.getRenderCamera()
Returns the current render camera object.
<static>  
sandboxe.graphics.setCamera2d()
Sets the current camera to view from for 2D renderings.
<static>  
sandboxe.graphics.setCamera3d()
Sets the current camera to view from for 3D renderings.
<static>  
sandboxe.graphics.setDrawEachFrame()
Sets whether or not to automatically draw, commit, and clear.
<static>  
sandboxe.graphics.setEnableFiltering()
Disables or enables bilinear filtering of Images during rendering.
<static>  
sandboxe.graphics.setRenderCamera()
Sets the current camera that processes all visuals and hands them to the display i.e.
Namespace Detail
sandboxe.graphics
Functions for working with rendering setup and actions. Note that most rendering actions are done through components such as shape2d or renderMesh.
Method Detail
<static> sandboxe.graphics.commit()
Forces the rendered scene to be drawn on the screen. This is normally done for you.

<static> sandboxe.graphics.draw(object)
Draws an object to the current display. This is normally done for you automatically by attaching copmonents and having the host entity as part of the main entity tree.
Parameters:
{shape2d|renderMesh} object
The object to draw.

<static> {camera} sandboxe.graphics.getCamera2d()
Returns the current 2d camera object.
Returns:
{camera}

<static> {camera} sandboxe.graphics.getCamera3d()
Returns the current 3d camera object.
Returns:
{camera}

<static> {boolean} sandboxe.graphics.getDrawEachFrame()
whether each frame is being drawn, updated, and swapped automatically by sandboxe or not.
Returns:
{boolean}

<static> {camera} sandboxe.graphics.getRenderCamera()
Returns the current render camera object.
Returns:
{camera}

<static> sandboxe.graphics.setCamera2d()
Sets the current camera to view from for 2D renderings. If invalid, the current camera is not changed.
Parameters:
{camera}

<static> sandboxe.graphics.setCamera3d()
Sets the current camera to view from for 3D renderings. If invalid, the current camera is not changed.
Parameters:
{camera}

<static> sandboxe.graphics.setDrawEachFrame()
Sets whether or not to automatically draw, commit, and clear.
Parameters:
{boolean}

<static> sandboxe.graphics.setEnableFiltering()
Disables or enables bilinear filtering of Images during rendering. Bilinear filtering makes stratched images look less grainy. The default is not to enable
Parameters:
{boolean}

<static> sandboxe.graphics.setRenderCamera()
Sets the current camera that processes all visuals and hands them to the display i.e. the window. If invalid, the current camera is not changed.
Parameters:
{camera}

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Feb 03 2019 18:30:57 GMT-0500 (EST)