Class Renderer

Creates a renderer object to use for drawing to a WebGL2 canvas

Hierarchy

Renderer

Index

Constructors

Properties

background gfxCanvas gl viewport

Methods

getNormalizedDeviceCoordinates render resize

Constructors

constructor

new Renderer(enableStencilBuffer?: boolean): Renderer
Creates a WebGL context for the given canvas element
Parameters
- enableStencilBuffer: boolean = false
  
  Whether to enable the stencil buffer for the WebGL context
Returns Renderer
- Defined in src/core/Renderer.ts:44

Properties

background

background: Color

The background color of the viewport

`Readonly` gfxCanvas

gfxCanvas: HTMLCanvasElement

The canvas element that the renderer draws to

`Readonly` gl

gl: WebGL2RenderingContext

The WebGL2 context used by the renderer

viewport

viewport: Viewport

The viewport of the renderer

Methods

getNormalizedDeviceCoordinates

getNormalizedDeviceCoordinates(mouseX: number, mouseY: number): Vector2
Gets the normalized device coordinates from the provided mouse coordinates.

Returns
The normalized device coordinates.
Parameters
- mouseX: number
  
  The x coordinate of the mouse.
- mouseY: number
  
  The y coordinate of the mouse.
Returns Vector2
- Defined in src/core/Renderer.ts:174

render

render(scene: Scene, camera: Camera): void
Draws the scene using the provided camera.
Parameters
- scene: Scene
  
  The scene to draw.
- camera: Camera
  
  The camera used to draw the scene.
Returns void
- Defined in src/core/Renderer.ts:154

resize

resize(width: number, height: number, aspectRatio: number): void
Resizes the graphics canvas and adjusts the viewport to maintain the provided aspect ratio.
Parameters
- width: number
  
  The width of the graphics canvas in pixels.
- height: number
  
  The height of the graphics canvas in pixels.
- aspectRatio: number
  
  The aspect ratio of the graphics canvas.
Returns void
- Defined in src/core/Renderer.ts:87

Generated using TypeDoc