iform bindings }; function getReadableState( texture ) { const textureProperties = properties.get( texture ); if ( textureProperties.__readFormat !== texture.format || textureProperties.__readType !== texture.type ) { textureProperties.__readFormat = texture.format; textureProperties.__readType = texture.type; textureProperties.__formatReadable = capabilities.textureFormatReadable( texture.format ); textureProperties.__typeReadable = capabilities.textureTypeReadable( texture.type ); } return textureProperties; } /** * Reads the pixel data from the given render target into the given buffer. * * @param {WebGLRenderTarget} renderTarget - The render target to read from. * @param {number} x - The `x` coordinate of the copy region's origin. * @param {number} y - The `y` coordinate of the copy region's origin. * @param {number} width - The width of the copy region. * @param {number} height - The height of the copy region. * @param {TypedArray} buffer - The result buffer. * @param {number} [activeCubeFaceIndex] - The active cube face index. * @param {number} [textureIndex=0] - The texture index of an MRT render target. */ this.readRenderTargetPixels = function ( renderTarget, x, y, width, height, buffer, activeCubeFaceIndex, textureIndex = 0 ) { if ( ! ( renderTarget && renderTarget.isWebGLRenderTarget ) ) { error( 'WebGLRenderer.readRenderTargetPixels: renderTarget is not THREE.WebGLRenderTarget.' ); return; } let framebuffer = properties.get( renderTarget ).__webglFramebuffer; if ( renderTarget.isWebGLCubeRenderTarget && activeCubeFaceIndex !== undefined ) { framebuffer = framebuffer[ activeCubeFaceIndex ]; } if ( framebuffer ) { state.bindFramebuffer( _gl.FRAMEBUFFER, framebuffer ); try { const texture = renderTarget.textures[ textureIndex ]; const textureFormat = texture.format; const textureType = texture.type; // when using MRT, select the correct color buffer for the subsequent read command if ( renderTarget.textures.length > 1 ) _gl.readBuffer( _gl.COLOR_ATTACHMENT0 + textureIndex ); const readableState = getReadableState( texture ); if ( readableState.__formatReadable === false ) { error( 'WebGLRenderer.readRenderTargetPixels: renderTarget is not in RGBA or implementation defined format.' ); return; } if ( readableState.__typeReadable === false ) { error( 'WebGLRenderer.readRenderTargetPixels: renderTarget is not in UnsignedByteType or implementation defined type.' ); return; } // the following if statement ensures valid read requests (no out-of-bounds pixels, see #8604) if ( ( x >= 0 && x <= ( renderTarget.width - width ) ) && ( y >= 0 && y <= ( renderTarget.height - height ) ) ) { _gl.readPixels( x, y, width, height, utils.convert( textureFormat ), utils.convert( textureType ), buffer ); } } finally { // restore framebuffer of current render target if necessary const framebuffer = ( _currentRenderTarget !== null ) ? properties.get( _currentRenderTarget ).__webglFramebuffer : null; state.bindFramebuffer( _gl.FRAMEBUFFER, framebuffer ); } } }; /** * Asynchronous, non-blocking version of {@link WebGLRenderer#readRenderTargetPixels}. * * It is recommended to use this version of `readRenderTargetPixels()` whenever possible. * * @async * @param {WebGLRenderTarget} renderTarget - The render target to read from. * @param {number} x - The `x` coordinate of the copy region's origin. * @param {number} y - The `y` coordinate of the copy region's origin. * @param {number} width - The width of the copy region. * @param {number} height - The height of the copy region. * @param {TypedArray} buffer - The result buffer. * @param {number} [activeCubeFaceIndex] - The active cube face index. * @param {number} [textureIndex=0] - The texture index of an MRT render target. * @return {Promise} A Promise that resolves when the read has been finished. The resolve provides the read data as a typed array. */ this.readRenderTargetPixelsAsync = async function ( renderTarget, x, y, width, height, buffer, activeCubeFaceIndex, textureIndex = 0 ) { if ( ! ( renderTarget && renderTarget.isWebGLRenderTarget ) ) { throw new Error( 'THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not THREE.WebGLRenderTarget.' ); } let framebuffer = properties.get( renderTarget ).__webglFramebuffer; if ( renderTarget.isWebGLCubeRenderTarget && activeCubeFaceIndex !== undefined ) { framebuffer = framebuffer[ activeCubeFaceIndex ]; } if ( framebuffer ) { // the following if statement ensures valid read requests (no out-of-bounds pixels, see #8604) if ( ( x >= 0 && x <= ( renderTarget.width - width ) ) && ( y >= 0 && y <= ( renderTarget.height - height ) )