Browse Source

Docs: Add WebGLRenderer.setFramebuffer().

Mugen87 5 years ago
parent
commit
5dfa96a8f0

+ 3 - 0
docs/api/en/renderers/WebGLRenderer.html

@@ -445,6 +445,9 @@
 		<h3>[method:null setClearColor]( [param:Color color], [param:Float alpha] )</h3>
 		<p>Sets the clear color and opacity.</p>
 
+		<h3>[method:null setFramebuffer]( [param:WebGLFramebuffer value] )</h3>
+		<p>Sets the given WebGLFramebuffer. This method can only be used if no render target is set via [page:WebGLRenderer.setRenderTarget .setRenderTarget]().</p>
+
 		<h3>[method:null setPixelRatio]( [param:number value] )</h3>
 		<p>Sets device pixel ratio. This is usually used for HiDPI device to prevent bluring output canvas.</p>
 

+ 3 - 0
docs/api/zh/renderers/WebGLRenderer.html

@@ -402,6 +402,9 @@
 		<h3>[method:null setClearColor]( [param:Color color], [param:Float alpha] )</h3>
 		<p>设置颜色及其透明度</p>
 
+		<h3>[method:null setFramebuffer]( [param:WebGLFramebuffer value] )</h3>
+		<p>Sets the given WebGLFramebuffer. This method can only be used if no render target is set via [page:WebGLRenderer.setRenderTarget .setRenderTarget]().</p>
+
 		<h3>[method:null setPixelRatio]( [param:number value] )</h3>
 		<p>设置设备像素比。通常用于避免HiDPI设备上绘图模糊</p>
 

+ 8 - 0
src/renderers/WebGLRenderer.d.ts

@@ -366,6 +366,14 @@ export class WebGLRenderer implements Renderer {
 	 */
 	getActiveMipmapLevel(): number;
 
+	/**
+	 * Sets the given WebGLFramebuffer. This method can only be used if no render target is set via
+	 * {@link WebGLRenderer#setRenderTarget .setRenderTarget}.
+	 *
+	 * @param value The WebGLFramebuffer.
+	 */
+	setFramebuffer( value: WebGLFramebuffer ): void;
+
 	/**
 	 * Returns the current render target. If no render target is set, null is returned.
 	 */