abstractnew Tiny.SystemRenderer(system, width, height, options)
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
system |
string |
The name of the system this renderer is for. |
||||||||||||||||||||||||||||||||||||||||
width |
number |
the width of the screen |
||||||||||||||||||||||||||||||||||||||||
height |
number |
the height of the screen |
||||||||||||||||||||||||||||||||||||||||
options |
object |
optional
The optional renderer parameters
|
Extends
- EventEmitter
Members
-
autoResizeboolean
-
Whether css dimensions of canvas view should be resized to screen dimensions automatically
-
backgroundColornumber
-
The background color to fill if not transparent
-
blendModesobject.<string, mixed>
-
Tracks the blend modes useful for this renderer.
-
clearBeforeRenderboolean
-
This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the scene is NOT transparent Tiny will use a canvas sized fillRect operation every frame to set the canvas background color. If the scene is transparent Tiny will use clearRect to clear the canvas every frame. Disable this by setting this to false. For example if your game has a canvas filling background image you often don't need this set. -
readonlyheightnumber
-
Same as view.height, actual number of pixels in the canvas by vertical
-
readonlyoptionsobject
-
The supplied constructor options.
-
preserveDrawingBufferboolean
-
The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
-
resolutionnumber
-
The resolution / device pixel ratio of the renderer
- Default Value:
- 1
-
roundPixelsboolean
-
If true Tiny will Math.floor() x/y values when rendering, stopping pixel interpolation.
Handy for crisp pixel art and speed on legacy devices. -
screenTiny.Rectangle
-
Measurements of the screen. (0, 0, screenWidth, screenHeight)
Its safe to use as filterArea or hitArea for whole stage
-
transparentboolean
-
Whether the render view is transparent
-
typenumber
-
The type of the renderer.
- Default Value:
- Tiny.RENDERER_TYPE.UNKNOWN
- See:
-
viewHTMLCanvasElement
-
The canvas element that everything is drawn to
-
readonlywidthnumber
-
Same as view.width, actual number of pixels in the canvas by horizontal
Methods
-
destroy(removeView)
-
Removes everything from the renderer and optionally removes the Canvas DOM element.
Name Type Default Description removeViewboolean false optional Removes the Canvas element from the DOM.
-
generateTexture(displayObject, scaleMode, resolution, region) ❯ {Tiny.Texture}
-
Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.Name Type Description displayObjectTiny.DisplayObject The displayObject the object will be generated from
scaleModenumber Should be one of the scaleMode consts
resolutionnumber The resolution / device pixel ratio of the texture being generated
regionTiny.Rectangle optional The region of the displayObject, that shall be rendered, if no region is specified, defaults to the local bounds of the displayObject.
Returns:
Type Description Tiny.Texture a texture of the graphics object -
resize(screenWidth, screenHeight)
-
Resizes the screen and canvas to the specified width and height
Canvas dimensions are multiplied by resolutionName Type Description screenWidthnumber the new width of the screen
screenHeightnumber the new height of the screen