Three.js

WebGLRenderer( parameters )

Допустимы следующие параметры:

.autoClear

Свойство определяет, будет ли визуализатор (рендерер) автоматически очищать свой выход перед визуализацией (рендерингом).

.autoClearColor

Свойство определяет, должен ли визуализатор (рендерер) очищать буфер цвета, если значение свойства autoClear установлено как true. Значением по умолчанию является true.

.autoClearDepth

Свойство определяет, должен ли визуализатор (рендерер) очищать буфер глубины, если значение свойства autoClear установлено как true. Значением по умолчанию является true.

.autoClearStencil

Свойство определяет, должен ли визуализатор (рендерер) очищать буфер трафарета, если значение свойства autoClear установлено как true. Значением по умолчанию является true.

.capabilities

Объект, содержащий сведения о возможностях текущего RenderingContext. Вот статья Википедии о RenderingContext на русском языке.

.clippingPlanes

User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply globally. Points in space whose dot product with the plane is negative are cut away. Значением по умолчанию является [].

.context

The renderer obtains a RenderingContext context from its domElementdomElement by default, using HTMLCanvasElement.getContext().
You can create this manually, however it must correspond to the domElement in order to render to the screen.

— «объектная модель документа»)')" onmouseout="hide()">.domElement

Элемент canvas - холст, на котором рендерер (визуализатор) рисует свой where the renderer draws its output.
Он автоматически создается визуализатором (рендерером) в конструкторе (если уже не предоставлен); нужно просто добавить его на страницу, вот так:

document.body.appendChild( renderer.domElement );

.extensions

Оболочка для метода extensions.get, используется для проверки поддержки различных расширений WebGL.

.gammaFactor

Гамма-коррекция, т.е. коррекция яркости или цветовых компонентов цифрового изображения или видео. Значение по умолчанию равно 2.

.gammaInput

Если свойство установлено, то предполагается, что все текстуры и цвета предварительно перемножены на значение gammaFactor. Значением по умолчанию является false.

.gammaOutput

Если свойство установлено то предполагается, что все текстуры и цвета должны выводиться предварительно перемноженными на значение gammaFactor. Значением по умолчанию является false.

.info

Объект с рядом статических сведений о памяти видеокарты и процессе визуализации. Полезно при отладке или просто из любопытства. Объект содержит следующие поля:

.localClippingEnabled

Свойство определяет, соблюдает ли рендерер (визуализатор) плоскости отсечения на уровне объекта. Defines whether the renderer respects object-level clipping planes. Значением по умолчанию является false.

.maxMorphNormals

Значение по умолчанию равно 4. Максимальное число MorphNormals допускаемых в шейдере. Имейте ввиду, что для стандартных материалов разрешается только 4 MorphNormals.

.maxMorphTargets

Значение по умолчанию равно 8. Максимальное число целей морфинга (MorphTargets), допускаемых в шейдере. Имейте ввиду, что стандартные материалы допускают только 8 целей морфинга. Default is 8. The maximum number of MorphTargets allowed in a shader. Keep in mind that the standard materials only allow 8 MorphTargets.

.physicallyCorrectLights

Свойство определяет, использовать ли режим освещения, правильный с точки зрения физики. Значением по умолчанию является false. Смотрите пример lights / physical.

.properties

Used internally by the renderer to keep track of various sub object properties.

render lists - списки визуализации')" onmouseout="hide()">.renderLists

Used internally to handle ordering of scene object rendering.

shadow map - теневая карта')" onmouseout="hide()">.shadowMap

This contains the reference to the shadow map, if used.

.shadowMap.enabled

Если свойство установлено, на сцене используются теневые карты. Значением по умолчанию является false.

.shadowMap.autoUpdate

Enables automatic updates to the shadows in the scene. Значением по умолчанию является true.
If you do not require dynamic lighting / shadows, you may set this to false when the renderer is instantiated.

.shadowMap.needsUpdate

When set to true, shadow maps in the scene will be updated in the next render call. Значением по умолчанию является false.
If you have disabled automatic updates to shadow maps (shadowMap.autoUpdate = false), you will need to set this to true and then make a render call to update the shadows in your scene.

.shadowMap.type

Defines shadow map type (unfiltered, percentage close filtering, percentage close filtering with bilinear filtering in shader)
Options are THREE.BasicShadowMap, THREE.PCFShadowMap (default), THREE.PCFSoftShadowMap. See WebGLRenderer constants for details.

.sortObjects

Свойство определяет, будет ли рендерер (визуализатор) сортировать объекты. Значением по умолчанию является true.

.state

Объект содержит функции для установки разных свойств состояния WebGLRenderer.context.

.toneMapping

Значением по умолчанию является LinearToneMapping. Другие варианты смотрите в описании констант WebGLRenderer'а.

.toneMappingExposure

Уровень экспозиции отображения тонов. Значение по умолчанию равно 1.

.toneMappingWhitePoint

Tone mapping white point. Значение по умолчанию равно 1.

.allocTextureUnit

Метод пытается выделить блок текстуры для использования шейдером. При попытке выделения блоков текстуры больше, чем поддерживается GPU, будет предупреждение. В основном этот метод используется внутренне. Смотрите описание свойства capabilities.maxTextures.

.clear( color, depth, stencil )

Метод указывает рендереру очистить буфер(ы) прорисовки цвета, глубины или трафарета. Данный метод инициализирует буфер цвета с текущим значением прозрачного цвета. По умолчанию аргументы равны true.

.clearColor( )

Метод очищает буфер цвета. Равнозначен вызову метода .clear( true, false, false ).

.clearDepth( )

Метод очищает буфер глубины. Равнозначен вызову метода .clear( false, true, false ).

.clearStencil( )

Метод очищает буфер трафарета. Равнозначен вызову метода .clear( false, false, true ).

.clearTarget( renderTarget, color, depth, stencil )

Этот метод очищает целевой буфер визуализации. Чтобы сделать это, он активирует целевой буфер визуализации.

.compile( 
scene - сцена')" onmouseout="hide()">scene, 
camera - камера')" onmouseout="hide()">camera )

Compiles all materials in the scene with the camera. This is useful to precompile shaders before the first rendering.

копировать буфер кадра в текстуру')" onmouseout="hide()">.copyFramebufferToTexture( 
position - положение, позиция')" onmouseout="hide()">position, 
texture - текстура')" onmouseout="hide()">texture, level )

Метод копирует пикселы из текущего WebGLFramebuffer в двумерную текстуру. Включает доступ к WebGLRenderingContext.copyTexImage2D.

.dispose( )

Удаляет текущий контекст визуализации.

.extensions.get( extensionName )

Метод используется для проверки поддержки разных расширений и, если таковая имеется, возвращает объект с подробной информацией о расширении. Он может проверять следующие расширения:

.forceContextLoss( )

Имитация потери контекста WebGL. Это требует поддержки расширений WEBGL_lose_context. По данным WebGLStats, по состоянию на февраль 2016 года, его поддерживают свыше 90% устройств совместимых с WebGL.

.getClearAlpha( )

Возвращает текущее значение альфа-канала прозрачности. Диапазон значений от 0 до 1.

get clear color - получить цвет')" onmouseout="hide()">.getClearColor( )

Метод возвращает экземпляр THREE.Color со значением текущего цвета with the current clear color.

get context - получить контекст')" onmouseout="hide()">.getContext( )

Метод возвращает текущий контекст WebGL.

get context attributes - получить атрибуты контекста')" onmouseout="hide()">.getContextAttributes( )

Возвращает объект с описанием атрибутов, установленных в контексте WebGL при его создании.

get RenderTarget - получить RenderTarget')" onmouseout="hide()">.getRenderTarget( )

Метод возвращает текущий RenderTarget, если таковой имеется.

get current viewport - получить (параметры) текущей области просмотра')" onmouseout="hide()">.getCurrentViewport( )

Возвращает параметры текущей области просмотра (viewport).

.getDrawingBufferSize( )

Метод возвращает объект, содержащий ширину и высоту буфера рисования визуализатора (рендерера) в пикселах.

.getPixelRatio( )

Возвращает используемый диапазон пикселей текущего устройства. Returns current device pixel ratio used.

.getSize( )

Метод возвращает объект, содержащий ширину и высоту выходного canvas визуализатора (рендерера) в пикселах. Returns an object containing the width and height of the renderer's output canvas, in pixels.

.resetGLState( )

Сбрасывает состояние GL в состояние, принятое по умолчанию. Вызывается внутренне при потере WebGL контекста. Reset the GL state to default. Called internally if the WebGL context is lost.

.readRenderTargetPixels( renderTarget, x, y, width, height, buffer )

Reads the pixel data from the renderTarget into the buffer you pass in. Buffer should be a Javascript Uint8Array instantiated with new Uint8Array( renderTargetWidth * renderTargetWidth * 4 ) to account for size and color information. Это оболочка вокруг gl.readPixels.
Посмотрите пример interactive / cubes / gpu.

.render( 
scene - сцена')" onmouseout="hide()">scene, 
camera - камера')" onmouseout="hide()">camera, renderTarget, forceClear )

Метод отображает
scene - сцена')" onmouseout="hide()">сцену при помощи
camera - камера')" onmouseout="hide()">камеры.
Прорисовка выполняется на renderTarget (если указан) или как обычно на canvas.
Если аргумент forceClear установлен как true, буферы глубины, трафарета и цвета перед отображением будут очищены, даже если свойство рендерера autoClear установлено как false. Хотя, если аргумент forceClear установлен как true, возможно предотвратить очистку определенных буферов установкой любого из свойств autoClearColor, autoClearStencil или autoClearDepth как false.

.renderBufferDirect( 
camera - камера')" onmouseout="hide()">camera, lights, 
fog - туман')" onmouseout="hide()">fog, 
material - материал')" onmouseout="hide()">material, geometryGroup, 
object - объект')" onmouseout="hide()">object )

Отображает группу буферных геометрических элементов при помощи камеры и с указанным материалом.

вывести (отобразить) буфер немедленно')" onmouseout="hide()">.renderBufferImmediate( 
object - объект')" onmouseout="hide()">object, 
program - программа')" onmouseout="hide()">program, 
shading - затенение')" onmouseout="hide()">shading )

Выводит ближайший буфер. Получает вызов от renderImmediateObject.

.setClearAlpha( alpha )

Установка значения альфа-канала. Допустимое входное значение - число с плавающей запятой в диапазоне от 0.0 до 1.0.

.setClearColor( 
color - цвет')" onmouseout="hide()">color, alpha )

Метод устанавливает прозрачный цвет и непрозрачность (opacity). Sets the clear color and opacity.

.setPixelRatio( value )

Метод устанавливает пиксельный диапазон устройства. Обычно он используется для HiDPI устройства для предотвращения размытия выходного canvas. Sets device pixel ratio. This is usually used for HiDPI device to prevent bluring output canvas.

.setRenderTarget( renderTarget )

Данный метод устанавливает действующий целевой буфер визуализации (renderTarget). Если параметр опущен, в качестве действующего renderTarget устанавливается canvas.

.setScissor( x, y, width, height )

Устанавливает область обрезки из (x, y) до (x + width, y + height)

.setScissorTest( boolean )

Включает или отключает проверку обрезки. Когда она включена, в дальнейших действиях визуализатора будут затронуты только пиксели в определенной области обрезки. Enable or disable the scissor test. When this is enabled, only the pixels within the defined scissor area will be affected by further renderer actions.

.supportsVertexTextures( )

Возвращает логическое значение true, если контекст поддерживает текстуры вершин. Этот метод устарел и заменяется на capabilities.vertexTexures.

.setSize( width, height, updateStyle )

Изменяет размеры выходного холста (canvas) к (width, height) Resizes the output canvas to (width, height) with device pixel ratio taken into account, а также устанавливает область просмотра (viewport) в соответствии с этим размером, начиная с (0, 0). Установка параметра updateStyle как true добавляет adds explicit pixel units to the output canvas style.

.setTexture2D( 
texture - текстура')" onmouseout="hide()">texture, slot )

This method sets the correct texture to the correct slot for the WebGL shader. The slot number can be found as a value of the uniform of the sampler.

.setTextureCube( cubeTexture, slot )

Этот метод устанавливает правильную текстуру с правильным интервалом для шейдера WebGL. Размер интервала можно найти как значение This method sets the correct texture to the correct slot for the WebGL shader. The slot number can be found as a value of the uniform of the sampler.

.setViewport( x, y, width, height )

Метод устанавливает область просмотра (viewport) визуализации от (x, y) до (x + width, y + height).

WebGLRenderTarget( width, height, options )

Возможны следующие опции:

• wrapS - константа, значением по умолчанию является THREE.ClampToEdgeWrapping.
• wrapT - константа, значением по умолчанию является THREE.ClampToEdgeWrapping.
• magFilter - константа, значением по умолчанию является THREE.LinearFilter.
• minFilter - константа, значением по умолчанию является THREE.LinearFilter.
• format - константа, значением по умолчанию является
  (сокращ. по первым буквам) - красный (red),
  зеленый (green), синий (blue), альфа-канал
  (прозрачность)')" onmouseout="hide()">THREE.RGBAFormat.
• type - константа, значением по умолчанию является THREE.UnsignedByteType.
• 
  свойств среды по разным направлениям')" onmouseout="hide()">anisotropy — значением по умолчанию является 1. Смотрите описание свойства Texture.anisotropy.
• encoding - константа, значением по умолчанию является THREE.LinearEncoding.
• depthBuffer — логическое значение, по умолчанию равно true. Установите его как false, если буфер глубины не нужен.
• stencilBuffer — логическое значение, по умолчанию равно true. Установите его как false, если буфер трафарета не нужен.

- универсальный уникальный идентификатор')" onmouseout="hide()">.uuid

Уникальное число для данного экземпляра целевого буфера визуализации.

.width

Ширина целевого буфера визуализации.

.height

Высота целевого буфера визуализации.

scissor - вырезать ножницами')" onmouseout="hide()">.scissor

Прямоугольная область внутри окна просмотра целевого буфера визуализации. Фрагменты, находящиеся за пределами этой области, будут отбрасываться.

.scissorTest

Свойство показывает, активна или нет проверка обрезки. Indicates whether the scissor test is active or not.

viewport - окно (область) просмотра')" onmouseout="hide()">.viewport

Область (окно) просмотра данного целевого буфера визуализации.

texture - текстура')" onmouseout="hide()">.texture

This texture instance holds the rendered pixels. Use it as input for further processing.

.depthBuffer

Свойство определяет, представлять ли буфер глубины. Значением по умолчанию является true.

.stencilBuffer

Свойство определяет, представлять ли буфер трафаретов. Значением по умолчанию является true.

depth texture - текстура глубины')" onmouseout="hide()">depthTexture

Если это свойство установлено, глубина сцены будет отображаться по данной текстуре. Значением по умолчанию является null.

.setSize( width, height )

Устанавливает размеры данного целевого буфера визуализации.

clone - клонировать')" onmouseout="hide()">.clone()

Создает копию данного целевого буфера визуализации.

copy - копировать')" onmouseout="hide()">.copy( 
source - источник')" onmouseout="hide()">source )

Перенимает настройки заданного (в параметре source) целевого буфера визуализации.

.dispose()

Метод отправляет Dispatches a dispose event.

WebGLRenderTargetCube( width, height, options )

Возможны следующие опции:

.activeCubeFace

Свойство activeCubeFace соответствует стороне куба (PX 0, NX 1, PY 2, NY 3, PZ 4, NZ 5) and is used and set internally by the CubeCamera.