Renderer - Documentation

Constructor

new Renderer(options)

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`canvas`	HTMLElement	<optional>		Элемент canvas
`gl`	WebGLRenderingContext	<optional>		Если элемент canvas не указан, то можно напрямую передать WebGL контекст
`pixelRatio`	Number	<optional>	1	Pixel ratio экрана
`antialias`	Boolean	<optional>	true	Использовать ли антиалиасинг
`autoClear`	Boolean	<optional>	true	Стирать ли прошлый кадр перед новый рендерингом
`clearColor`	Array	<optional>	true	Цвет заливки в формате RGBA
`sortObjects`	Object	<optional>	true	Нужно ли сортировать прозрачные объекты по удаленности или по renderOrder

Members

autoClear :Boolean

Определяет стирать ли прошлый кадр перед новым рендерингом

clearColor :Array

Цвет заливки в формате RGBA

Methods

addPlugin(plugin, ordernullable)

Добавляет RendererPlugin к рендеру. К рендеру может быть добавлен только один плагин каждого типа.

Parameters:

Name	Type	Attributes	Description
`plugin`	Plugin		Плагин
`order`	Number	<nullable>	Каждый плагин выполняется при рендеринге по возрастанию order, если его нет, то выбирается максимальный order + 1.

clear()

Очищает текущий кадр и заливает цветом указанным в clearColor

getPixelRatio() → {Number}

Возвращает текущий pixel ratio

Returns:

Type: Number

getSize() → {Array}

Возвращает текущий viewport WebGL

Returns:

Type: Array

readPixels(x, y, width, height, array)

Считывает указанную область пикселей в массив

Parameters:

Name	Type	Description
`x`	Number	Координаты начала области
`y`	Number	Координаты начала области
`width`	Number	Ширина области
`height`	Number	Высота области
`array`	TypedArray	Массив для записи данных

removePlugin(Plugin)

Удаляет RendererPlugin из рендера.

Parameters:

Name	Type	Description
`Plugin`	Plugin	Класс плагина

render(scene, camera, userData)

Рисует сцену

Parameters:

Name	Type	Description
`scene`	Scene	Сцена
`camera`	Camera	Камера
`userData`	*	Дополнительная информация, которая будет передана всем плагинам и объектам

setPixelRatio(value)

Устанавливает параметр pixel ratio

Parameters:

Name	Type	Description
`value`	Number

setRenderTarget(renderTargetnullable)

Устанавливает RenderTarget

Parameters:

Name	Type	Attributes	Description
`renderTarget`	RenderTarget	<nullable>

setSize(width, height)

Устанавливает размеры элементу canvas и viewport для WebGL

Parameters:

Name	Type	Description
`width`	Number	Ширина в пикселях
`height`	Number	Высота в пикселях

setViewport(widthopt, heightopt)

Устанавливает viewport для WebGL Если размеры не указаны, то выставляет размеры указанные в функции Renderer#setSize

Parameters:

Name	Type	Attributes	Description
`width`	Number	<optional>	Ширина в пикселях
`height`	Number	<optional>	Высота в пикселях