From 453cdabb7efb9f15b00a6b81518fa702951796cb Mon Sep 17 00:00:00 2001 From: Lewy Blue Date: Fri, 4 Nov 2016 21:59:56 +0000 Subject: [PATCH] Created new document page Constants / Renderer (#10002) * Created constants / renderer * renamed Renderer.html to WebGLRenderer.html --- docs/api/constants/GLState.html | 51 ----------------- docs/api/constants/ShadowingTypes.html | 42 -------------- docs/api/constants/WebGLRenderer.html | 78 ++++++++++++++++++++++++++ docs/api/renderers/WebGLRenderer.html | 4 +- docs/list.js | 5 +- 5 files changed, 82 insertions(+), 98 deletions(-) delete mode 100644 docs/api/constants/GLState.html delete mode 100644 docs/api/constants/ShadowingTypes.html create mode 100644 docs/api/constants/WebGLRenderer.html diff --git a/docs/api/constants/GLState.html b/docs/api/constants/GLState.html deleted file mode 100644 index 277759164c..0000000000 --- a/docs/api/constants/GLState.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - -

GL State Constants

- These are used by the WebGLRenderer to set gl.cullFace and gl.frontFace states in the GPU. - -

Cull Face Modes

- - THREE.CullFaceNone - -

Disable face culling.

- - THREE.CullFaceBack - -

Cull back faces (default).

- - THREE.CullFaceFront - -

Cull front faces.

- - THREE.CullFaceFrontBack - -

Cull both front and back faces.

- -

Front Face Direction

- Set the winding order for polygons to either clockwise or counter-clockwise (default). - - THREE.FrontFaceDirectionCW - THREE.FrontFaceDirectionCCW - - -

Usage

- - - var renderer = new THREE.WebGLRenderer(); - - renderer.setFaceCulling ( THREE.CullFaceBack, THREE.FrontFaceDirectionCCW ); //defaults - - -

Source

- - [link:https://github.com/mrdoob/three.js/blob/master/src/constants.js src/constants.js] - - diff --git a/docs/api/constants/ShadowingTypes.html b/docs/api/constants/ShadowingTypes.html deleted file mode 100644 index 9b81ccc749..0000000000 --- a/docs/api/constants/ShadowingTypes.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - - -

Shadowing Type Constants

-

These define the shadow map types used by the WebGLRenderer.

- -

Shadow Map Types

- - THREE.BasicShadowMap - -

Unfiltered shadow maps - fastest, but lowest quality.

- - THREE.PCFShadowMap - -

Shadow maps filtered using the Percentage-Closer Filtering (PCF) algorithm (default).

- - THREE.PCFSoftShadowMap - -

Shadow maps filtered using the Percentage-Closer Soft Shadows (PCSS) algorithm.

- -

Usage

- - var renderer = new THREE.WebGLRenderer(); - renderer.shadowMap.enabled = true; - renderer.shadowMap.type = THREE.PCFShadowMap; //default - - - Note that this just enables shadows in the renderer and sets the shadow map type.
- To actually cast shadows you will have to set up shadows for the any light you want to cast shadows, and for meshes you want to cast / receive shadows.
- -

Source

- - [link:https://github.com/mrdoob/three.js/blob/master/src/constants.js src/constants.js] - - diff --git a/docs/api/constants/WebGLRenderer.html b/docs/api/constants/WebGLRenderer.html new file mode 100644 index 0000000000..01aa3c9bda --- /dev/null +++ b/docs/api/constants/WebGLRenderer.html @@ -0,0 +1,78 @@ + + + + + + + + + + +

WebGLRenderer Constants

+ +

Cull Face Modes

+ + THREE.CullFaceNone + THREE.CullFaceBack + THREE.CullFaceFront + THREE.CullFaceFrontBack + +
+ These are used by the WebGLRenderer's [page:WebGLRenderer.setFaceCulling setFaceCulling] method.

+ [page:constant CullFaceNone] disables face culling.
+ [page:constant CullFaceBack] culls back faces (default).
+ [page:constant CullFaceFront] culls front faces.
+ [page:constant CullFaceFrontBack] culls both front and back faces. +
+ +

Front Face Direction

+ + THREE.FrontFaceDirectionCW + THREE.FrontFaceDirectionCCW + +
+ These are used by the WebGLRenderer's [page:WebGLRenderer.setFaceCulling setFaceCulling] method.

+ [page:constant FrontFaceDirectionCW] sets the winding order for polygons to clockwise.
+ [page:constant FrontFaceDirectionCW] sets the winding order for polygons to counter-clockwise (default). +
+ +

Shadow Types

+ + THREE.BasicShadowMap + THREE.PCFShadowMap + THREE.PCFSoftShadowMap + +
+ These define the WebGLRenderer's [page:WebGLRenderer.shadowMap.type shadowMap.type] property.

+ + [page:constant BasicShadowMap] gives unfiltered shadow maps - fastest, but lowest quality.
+ [page:constant PCFShadowMap] filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm (default).
+ [page:constant PCFSoftShadowMap] filters shadow maps using the Percentage-Closer Soft Shadows (PCSS) algorithm. +
+ +

Tone Mapping

+ + THREE.NoToneMapping + THREE.LinearToneMapping + THREE.ReinhardToneMapping + THREE.Uncharted2ToneMapping + THREE.CineonToneMapping + +
+ These define the WebGLRenderer's [page:WebGLRenderer.toneMapping toneMapping] property. + This is used to approximate the appearance of high dynamic range (HDR) on the + low dynamic range medium of a standard computer monitor or mobile device's screen.

+ + [page:constant NoToneMapping] disables tone mapping.
+ [page:constant LinearToneMapping] is the default.

+ + See the [example:webgl_tonemapping WebGL / tonemapping] example. + +
+ + +

Source

+ + [link:https://github.com/mrdoob/three.js/blob/master/src/constants.js src/constants.js] + + diff --git a/docs/api/renderers/WebGLRenderer.html b/docs/api/renderers/WebGLRenderer.html index 83d41eac50..50b0f02e49 100644 --- a/docs/api/renderers/WebGLRenderer.html +++ b/docs/api/renderers/WebGLRenderer.html @@ -103,7 +103,7 @@

[property:Integer 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 [page:ShadowingTypes ShadowingTypes constants] for details.
+
Options are THREE.BasicShadowMap, THREE.PCFShadowMap (default), THREE.PCFSoftShadowMap. See [page:WebGLRenderer WebGLRenderer constants] for details.

[property:Boolean shadowMap.renderReverseSided]

@@ -240,7 +240,7 @@

[method:null setFaceCulling]( cullFace, frontFace )

- See [page:GLState GLState constants] for all possible values for [page:String cullFace] and [page:String frontFace].
+ See [page:WebGLRenderer WebGLRenderer constants] for all possible values for [page:String cullFace] and [page:String frontFace].
Used for setting the gl.frontFace and gl.cullFace states in the GPU, thus enabling/disabling face culling when rendering.
If cullFace is set to THREE.[page:String CullFaceNone], culling will be disabled.
diff --git a/docs/list.js b/docs/list.js index 84d8f4c40a..5f2688a734 100644 --- a/docs/list.js +++ b/docs/list.js @@ -12,10 +12,9 @@ var list = { [ "Animation", "api/constants/Animation" ], [ "CustomBlendingEquation", "api/constants/CustomBlendingEquations" ], [ "DrawModes", "api/constants/DrawModes" ], - [ "GLState", "api/constants/GLState" ], [ "Materials", "api/constants/Materials" ], - [ "ShadowingTypes", "api/constants/ShadowingTypes" ], - [ "Textures", "api/constants/Textures" ] + [ "Textures", "api/constants/Textures" ], + [ "WebGLRenderer", "api/constants/WebGLRenderer" ] ], "Cameras": [ -- GitLab