7601 lines
150 KiB
HTML
7601 lines
150 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
|
|
<title>Context - Cesium Documentation</title>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
<script src="javascript/all.js"></script>
|
|
<!-- Syntax Highlighting -->
|
|
<link rel="stylesheet" href="styles/shCore.css" media="all"></link>
|
|
<link rel="stylesheet" href="styles/shThemeDefault.css" media="all"></link>
|
|
<script src="javascript/shCore.js"></script>
|
|
<script src="javascript/shBrushJScript.js"></script>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="nav">
|
|
<div class="menu">
|
|
<a href="http://cesium.agi.com/"><img src="images/CesiumLogo.jpg" class="menuLogo"/></a>
|
|
<div class="rightLinks indexLinks">
|
|
<a href="index.html">top</a>
|
|
</div>
|
|
<div class="indexLinks">
|
|
<a id="allLink">all</a>
|
|
<a id="jsIndexLink">js</a>
|
|
<a id="glslIndexLink">glsl</a>
|
|
</div>
|
|
<div class="divider"></div>
|
|
<form name="filterForm" method="get" onsubmit="return false;">
|
|
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
|
|
<input type="hidden" id="filterType" value="all"/>
|
|
</form>
|
|
<ul id="ClassList"><div id="classItems"><li><a href="AnimationCollection.html">AnimationCollection</a></li><li><a href="AnimationController.html">AnimationController</a></li><li><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li><a href="Billboard.html">Billboard</a></li><li><a href="BillboardCollection.html">BillboardCollection</a></li><li><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li><a href="BoundingRectangle.html">BoundingRectangle</a></li><li><a href="BoundingSphere.html">BoundingSphere</a></li><li><a href="Buffer.html">Buffer</a></li><li><a href="Camera.html">Camera</a></li><li><a href="CameraController.html">CameraController</a></li><li><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li><a href="Cartesian2.html">Cartesian2</a></li><li><a href="Cartesian3.html">Cartesian3</a></li><li><a href="Cartesian4.html">Cartesian4</a></li><li><a href="Cartographic.html">Cartographic</a></li><li><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li><a href="CentralBody.html">CentralBody</a></li><li><a href="CesiumViewerWidget.html">CesiumViewerWidget</a></li><li><a href="Clock.html">Clock</a></li><li><a href="Color.html">Color</a></li><li><a href="Command.html">Command</a></li><li><a href="CommandLists.html">CommandLists</a></li><li><a href="ComplexConicSensorVolume.html">ComplexConicSensorVolume</a></li><li><a href="CompositeDynamicObjectCollection.html">CompositeDynamicObjectCollection</a></li><li><a href="CompositePrimitive.html">CompositePrimitive</a></li><li><a href="Context.html">Context</a></li><li><a href="CubeMap.html">CubeMap</a></li><li><a href="CubeMapFace.html">CubeMapFace</a></li><li><a href="CustomSensorVolume.html">CustomSensorVolume</a></li><li><a href="DefaultProxy.html">DefaultProxy</a></li><li><a href="Deferred.html">Deferred</a></li><li><a href="DeveloperError.html">DeveloperError</a></li><li><a href="DiscardMissingTileImagePolicy.html">DiscardMissingTileImagePolicy</a></li><li><a href="DynamicBillboard.html">DynamicBillboard</a></li><li><a href="DynamicBillboardVisualizer.html">DynamicBillboardVisualizer</a></li><li><a href="DynamicColorMaterial.html">DynamicColorMaterial</a></li><li><a href="DynamicCone.html">DynamicCone</a></li><li><a href="DynamicConeVisualizer.html">DynamicConeVisualizer</a></li><li><a href="DynamicConeVisualizerUsingCustomSensor.html">DynamicConeVisualizerUsingCustomSensor</a></li><li><a href="DynamicDirectionsProperty.html">DynamicDirectionsProperty</a></li><li><a href="DynamicEllipsoid.html">DynamicEllipsoid</a></li><li><a href="DynamicEllipsoidVisualizer.html">DynamicEllipsoidVisualizer</a></li><li><a href="DynamicImageMaterial.html">DynamicImageMaterial</a></li><li><a href="DynamicLabel.html">DynamicLabel</a></li><li><a href="DynamicLabelVisualizer.html">DynamicLabelVisualizer</a></li><li><a href="DynamicMaterialProperty.html">DynamicMaterialProperty</a></li><li><a href="DynamicObject.html">DynamicObject</a></li><li><a href="DynamicObjectCollection.html">DynamicObjectCollection</a></li><li><a href="DynamicPath.html">DynamicPath</a></li><li><a href="DynamicPathVisualizer.html">DynamicPathVisualizer</a></li><li><a href="DynamicPoint.html">DynamicPoint</a></li><li><a href="DynamicPointVisualizer.html">DynamicPointVisualizer</a></li><li><a href="DynamicPolygon.html">DynamicPolygon</a></li><li><a href="DynamicPolygonVisualizer.html">DynamicPolygonVisualizer</a></li><li><a href="DynamicPolyline.html">DynamicPolyline</a></li><li><a href="DynamicPolylineVisualizer.html">DynamicPolylineVisualizer</a></li><li><a href="DynamicPositionProperty.html">DynamicPositionProperty</a></li><li><a href="DynamicProperty.html">DynamicProperty</a></li><li><a href="DynamicPyramid.html">DynamicPyramid</a></li><li><a href="DynamicPyramidVisualizer.html">DynamicPyramidVisualizer</a></li><li><a href="DynamicVertexPositionsProperty.html">DynamicVertexPositionsProperty</a></li><li><a href="Ellipsoid.html">Ellipsoid</a></li><li><a href="EllipsoidalOccluder.html">EllipsoidalOccluder</a></li><li><a href="EllipsoidPrimitive.html">EllipsoidPrimitive</a></li><li><a href="EllipsoidTangentPlane.html">EllipsoidTangentPlane</a></li><li><a href="EncodedCartesian3.html">EncodedCartesian3</a></li><li><a href="Enumeration.html">Enumeration</a></li><li><a href="Event.html">Event</a></li><li><a href="Extent.html">Extent</a></li><li><a href="Framebuffer.html">Framebuffer</a></li><li><a href="FrameState.html">FrameState</a></li><li><a href="FrustumCommands.html">FrustumCommands</a></li><li><a href="GeographicProjection.html">GeographicProjection</a></li><li><a href="GeographicTilingScheme.html">GeographicTilingScheme</a></li><li><a href="GregorianDate.html">GregorianDate</a></li><li><a href="HermiteSpline.html">HermiteSpline</a></li><li><a href="ImageryLayer.html">ImageryLayer</a></li><li><a href="ImageryLayerCollection.html">ImageryLayerCollection</a></li><li><a href="ImageryProvider.html">ImageryProvider</a></li><li><a href="Interval.html">Interval</a></li><li><a href="JulianDate.html">JulianDate</a></li><li><a href="Label.html">Label</a></li><li><a href="LabelCollection.html">LabelCollection</a></li><li><a href="LeapSecond.html">LeapSecond</a></li><li><a href="Material.html">Material</a></li><li><a href="Matrix2.html">Matrix2</a></li><li><a href="Matrix3.html">Matrix3</a></li><li><a href="Matrix4.html">Matrix4</a></li><li><a href="NeverTileDiscardPolicy.html">NeverTileDiscardPolicy</a></li><li><a href="Occluder.html">Occluder</a></li><li><a href="OpenStreetMapImageryProvider.html">OpenStreetMapImageryProvider</a></li><li><a href="OrientationInterpolator.html">OrientationInterpolator</a></li><li><a href="OrthographicFrustum.html">OrthographicFrustum</a></li><li><a href="PerformanceDisplay.html">PerformanceDisplay</a></li><li><a href="PerspectiveFrustum.html">PerspectiveFrustum</a></li><li><a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a></li><li><a href="PickFramebuffer.html">PickFramebuffer</a></li><li><a href="Polygon.html">Polygon</a></li><li><a href="Polyline.html">Polyline</a></li><li><a href="PolylineCollection.html">PolylineCollection</a></li><li><a href="Promise.html">Promise</a></li><li><a href="Quaternion.html">Quaternion</a></li><li><a href="Queue.html">Queue</a></li><li><a href="Ray.html">Ray</a></li><li><a href="RectangularPyramidSensorVolume.html">RectangularPyramidSensorVolume</a></li><li><a href="ReferenceProperty.html">ReferenceProperty</a></li><li><a href="RequestErrorEvent.html">RequestErrorEvent</a></li><li><a href="RuntimeError.html">RuntimeError</a></li><li><a href="Scene.html">Scene</a></li><li><a href="SceneTransitioner.html">SceneTransitioner</a></li><li><a href="ScreenSpaceCameraController.html">ScreenSpaceCameraController</a></li><li><a href="ScreenSpaceEventHandler.html">ScreenSpaceEventHandler</a></li><li><a href="SensorVolumeCollection.html">SensorVolumeCollection</a></li><li><a href="ShaderCache.html">ShaderCache</a></li><li><a href="ShaderProgram.html">ShaderProgram</a></li><li><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li><li><a href="SkyAtmosphere.html">SkyAtmosphere</a></li><li><a href="SkyBox.html">SkyBox</a></li><li><a href="Spherical.html">Spherical</a></li><li><a href="TaskProcessor.html">TaskProcessor</a></li><li><a href="Texture.html">Texture</a></li><li><a href="Texture2DPool.html">Texture2DPool</a></li><li><a href="TextureAtlas.html">TextureAtlas</a></li><li><a href="TextureAtlasBuilder.html">TextureAtlasBuilder</a></li><li><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></li><li><a href="TileMapServiceImageryProvider.html">TileMapServiceImageryProvider</a></li><li><a href="TilingScheme.html">TilingScheme</a></li><li><a href="TimeInterval.html">TimeInterval</a></li><li><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></li><li><a href="Uniform.html">Uniform</a></li><li><a href="UniformArray.html">UniformArray</a></li><li><a href="UniformState.html">UniformState</a></li><li><a href="VertexArray.html">VertexArray</a></li><li><a href="VertexArrayFacade.html">VertexArrayFacade</a></li><li><a href="ViewportQuad.html">ViewportQuad</a></li><li><a href="VisualizerCollection.html">VisualizerCollection</a></li><li><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li><li><a href="WebMercatorProjection.html">WebMercatorProjection</a></li><li><a href="WebMercatorTilingScheme.html">WebMercatorTilingScheme</a></li><li><a href="binarySearch.html">binarySearch</a></li><li><a href="BingMapsStyle.html">BingMapsStyle</a></li><li><a href="BlendEquation.html">BlendEquation</a></li><li><a href="BlendFunction.html">BlendFunction</a></li><li><a href="BlendingState.html">BlendingState</a></li><li><a href="BoxTessellator.html">BoxTessellator</a></li><li><a href="BufferUsage.html">BufferUsage</a></li><li><a href="CameraColumbusViewMode.html">CameraColumbusViewMode</a></li><li><a href="CameraEventType.html">CameraEventType</a></li><li><a href="CameraFlightPath.html">CameraFlightPath</a></li><li><a href="CesiumMath.html">CesiumMath</a></li><li><a href="ClockRange.html">ClockRange</a></li><li><a href="ClockStep.html">ClockStep</a></li><li><a href="combine.html">combine</a></li><li><a href="computeSunPosition.html">computeSunPosition</a></li><li><a href="createGuid.html">createGuid</a></li><li><a href="createTaskProcessorWorker.html">createTaskProcessorWorker</a></li><li><a href="CubeMapEllipsoidTessellator.html">CubeMapEllipsoidTessellator</a></li><li><a href="CubicRealPolynomial.html">CubicRealPolynomial</a></li><li><a href="CullFace.html">CullFace</a></li><li><a href="CzmlBoolean.html">CzmlBoolean</a></li><li><a href="CzmlCartesian2.html">CzmlCartesian2</a></li><li><a href="CzmlCartesian3.html">CzmlCartesian3</a></li><li><a href="CzmlCartographic.html">CzmlCartographic</a></li><li><a href="CzmlColor.html">CzmlColor</a></li><li><a href="CzmlDefaults.html">CzmlDefaults</a></li><li><a href="CzmlHorizontalOrigin.html">CzmlHorizontalOrigin</a></li><li><a href="CzmlImage.html">CzmlImage</a></li><li><a href="CzmlLabelStyle.html">CzmlLabelStyle</a></li><li><a href="CzmlNumber.html">CzmlNumber</a></li><li><a href="CzmlString.html">CzmlString</a></li><li><a href="CzmlUnitCartesian3.html">CzmlUnitCartesian3</a></li><li><a href="CzmlUnitQuaternion.html">CzmlUnitQuaternion</a></li><li><a href="CzmlUnitSpherical.html">CzmlUnitSpherical</a></li><li><a href="CzmlVerticalOrigin.html">CzmlVerticalOrigin</a></li><li><a href="defaultValue.html">defaultValue</a></li><li><a href="DepthFunction.html">DepthFunction</a></li><li><a href="destroyObject.html">destroyObject</a></li><li><a href="ExtentTessellator.html">ExtentTessellator</a></li><li><a href="FAR.html">FAR</a></li><li><a href="FeatureDetection.html">FeatureDetection</a></li><li><a href="freezeObject.html">freezeObject</a></li><li><a href="Fullscreen.html">Fullscreen</a></li><li><a href="getImagePixels.html">getImagePixels</a></li><li><a href="HermitePolynomialApproximation.html">HermitePolynomialApproximation</a></li><li><a href="HorizontalOrigin.html">HorizontalOrigin</a></li><li><a href="IndexDatatype.html">IndexDatatype</a></li><li><a href="Intersect.html">Intersect</a></li><li><a href="IntersectionTests.html">IntersectionTests</a></li><li><a href="Iso8601.html">Iso8601</a></li><li><a href="jsonp.html">jsonp</a></li><li><a href="KeyboardEventModifier.html">KeyboardEventModifier</a></li><li><a href="LabelStyle.html">LabelStyle</a></li><li><a href="LagrangePolynomialApproximation.html">LagrangePolynomialApproximation</a></li><li><a href="LinearApproximation.html">LinearApproximation</a></li><li><a href="loadArrayBuffer.html">loadArrayBuffer</a></li><li><a href="loadCubeMap.html">loadCubeMap</a></li><li><a href="loadImage.html">loadImage</a></li><li><a href="loadJson.html">loadJson</a></li><li><a href="loadText.html">loadText</a></li><li><a href="loadXML.html">loadXML</a></li><li><a href="MeshFilters.html">MeshFilters</a></li><li><a href="MipmapHint.html">MipmapHint</a></li><li><a href="PixelDatatype.html">PixelDatatype</a></li><li><a href="PixelFormat.html">PixelFormat</a></li><li><a href="PlaneTessellator.html">PlaneTessellator</a></li><li><a href="pointInsideTriangle2D.html">pointInsideTriangle2D</a></li><li><a href="PolygonPipeline.html">PolygonPipeline</a></li><li><a href="PolylinePipeline.html">PolylinePipeline</a></li><li><a href="PrimitiveType.html">PrimitiveType</a></li><li><a href="processCzml.html">processCzml</a></li><li><a href="Projections.html">Projections</a></li><li><a href="QuadraticRealPolynomial.html">QuadraticRealPolynomial</a></li><li><a href="QuarticRealPolynomial.html">QuarticRealPolynomial</a></li><li><a href="RenderbufferFormat.html">RenderbufferFormat</a></li><li><a href="requestAnimationFrame.html">requestAnimationFrame</a></li><li><a href="SceneMode.html">SceneMode</a></li><li><a href="ScreenSpaceEventType.html">ScreenSpaceEventType</a></li><li><a href="Shapes.html">Shapes</a></li><li><a href="StencilFunction.html">StencilFunction</a></li><li><a href="StencilOperation.html">StencilOperation</a></li><li><a href="TextureMagnificationFilter.html">TextureMagnificationFilter</a></li><li><a href="TextureMinificationFilter.html">TextureMinificationFilter</a></li><li><a href="TextureWrap.html">TextureWrap</a></li><li><a href="TimeConstants.html">TimeConstants</a></li><li><a href="TimeStandard.html">TimeStandard</a></li><li><a href="Tipsify.html">Tipsify</a></li><li><a href="Transforms.html">Transforms</a></li><li><a href="TridiagonalSystemSolver.html">TridiagonalSystemSolver</a></li><li><a href="UniformDatatype.html">UniformDatatype</a></li><li><a href="VertexLayout.html">VertexLayout</a></li><li><a href="VerticalOrigin.html">VerticalOrigin</a></li><li><a href="Visibility.html">Visibility</a></li><li><a href="WindingOrder.html">WindingOrder</a></li><li><a href="ComponentDatatype.html">ComponentDatatype</a></li></div><div id="glslItems"><li><a href="czm_cellular.html">czm_cellular</a></li><li><a href="czm_columbusView.html">czm_columbusView</a></li><li><a href="czm_columbusViewMorph.html">czm_columbusViewMorph</a></li><li><a href="czm_complement.html">czm_complement</a></li><li><a href="czm_cone.html">czm_cone</a></li><li><a href="czm_coneContainsPoint.html">czm_coneContainsPoint</a></li><li><a href="czm_degreesPerRadian.html">czm_degreesPerRadian</a></li><li><a href="czm_eastNorthUpToEyeCoordinates.html">czm_eastNorthUpToEyeCoordinates</a></li><li><a href="czm_ellipsoid.html">czm_ellipsoid</a></li><li><a href="czm_ellipsoidContainsPoint.html">czm_ellipsoidContainsPoint</a></li><li><a href="czm_ellipsoidNew.html">czm_ellipsoidNew</a></li><li><a href="czm_ellipsoidSilhouetteCone.html">czm_ellipsoidSilhouetteCone</a></li><li><a href="czm_ellipsoidSilhouetteConeNew.html">czm_ellipsoidSilhouetteConeNew</a></li><li><a href="czm_ellipsoidSilhouetteConeNormal.html">czm_ellipsoidSilhouetteConeNormal</a></li><li><a href="czm_ellipsoidSilhouetteHalfspace.html">czm_ellipsoidSilhouetteHalfspace</a></li><li><a href="czm_ellipsoidSilhouetteHalfspaceNew.html">czm_ellipsoidSilhouetteHalfspaceNew</a></li><li><a href="czm_ellipsoidWgs84TextureCoordinates.html">czm_ellipsoidWgs84TextureCoordinates</a></li><li><a href="czm_emptyRaySegment.html">czm_emptyRaySegment</a></li><li><a href="czm_encodedCameraPositionMCHigh.html">czm_encodedCameraPositionMCHigh</a></li><li><a href="czm_encodedCameraPositionMCLow.html">czm_encodedCameraPositionMCLow</a></li><li><a href="czm_entireFrustum.html">czm_entireFrustum</a></li><li><a href="czm_epsilon1.html">czm_epsilon1</a></li><li><a href="czm_epsilon2.html">czm_epsilon2</a></li><li><a href="czm_epsilon3.html">czm_epsilon3</a></li><li><a href="czm_epsilon4.html">czm_epsilon4</a></li><li><a href="czm_epsilon5.html">czm_epsilon5</a></li><li><a href="czm_epsilon6.html">czm_epsilon6</a></li><li><a href="czm_epsilon7.html">czm_epsilon7</a></li><li><a href="czm_equalsEpsilon.html">czm_equalsEpsilon</a></li><li><a href="czm_eyeOffset.html">czm_eyeOffset</a></li><li><a href="czm_eyeToWindowCoordinates.html">czm_eyeToWindowCoordinates</a></li><li><a href="czm_frameNumber.html">czm_frameNumber</a></li><li><a href="czm_fullRaySegment.html">czm_fullRaySegment</a></li><li><a href="czm_geodeticSurfaceNormal.html">czm_geodeticSurfaceNormal</a></li><li><a href="czm_getDefaultMaterial.html">czm_getDefaultMaterial</a></li><li><a href="czm_getWgs84EllipsoidEC.html">czm_getWgs84EllipsoidEC</a></li><li><a href="czm_halfspace.html">czm_halfspace</a></li><li><a href="czm_infiniteProjection.html">czm_infiniteProjection</a></li><li><a href="czm_infinity.html">czm_infinity</a></li><li><a href="czm_insertAt.html">czm_insertAt</a></li><li><a href="czm_intersection.html">czm_intersection</a></li><li><a href="czm_inverseModel.html">czm_inverseModel</a></li><li><a href="czm_inverseModelView.html">czm_inverseModelView</a></li><li><a href="czm_inverseNormal.html">czm_inverseNormal</a></li><li><a href="czm_inverseProjection.html">czm_inverseProjection</a></li><li><a href="czm_inverseView.html">czm_inverseView</a></li><li><a href="czm_inverseViewRotation.html">czm_inverseViewRotation</a></li><li><a href="czm_isEmpty.html">czm_isEmpty</a></li><li><a href="czm_isFull.html">czm_isFull</a></li><li><a href="czm_latitudeToWebMercatorFraction.html">czm_latitudeToWebMercatorFraction</a></li><li><a href="czm_luminance.html">czm_luminance</a></li><li><a href="czm_material.html">czm_material</a></li><li><a href="czm_materialInput.html">czm_materialInput</a></li><li><a href="czm_model.html">czm_model</a></li><li><a href="czm_modelToWindowCoordinates.html">czm_modelToWindowCoordinates</a></li><li><a href="czm_modelView.html">czm_modelView</a></li><li><a href="czm_modelViewInfiniteProjection.html">czm_modelViewInfiniteProjection</a></li><li><a href="czm_modelViewProjection.html">czm_modelViewProjection</a></li><li><a href="czm_modelViewProjectionRelativeToEye.html">czm_modelViewProjectionRelativeToEye</a></li><li><a href="czm_modelViewRelativeToEye.html">czm_modelViewRelativeToEye</a></li><li><a href="czm_moonDirectionEC.html">czm_moonDirectionEC</a></li><li><a href="czm_morphing.html">czm_morphing</a></li><li><a href="czm_multiplyWithColorBalance.html">czm_multiplyWithColorBalance</a></li><li><a href="czm_normal.html">czm_normal</a></li><li><a href="czm_oneOverPi.html">czm_oneOverPi</a></li><li><a href="czm_oneOverTwoPi.html">czm_oneOverTwoPi</a></li><li><a href="czm_phong.html">czm_phong</a></li><li><a href="czm_pi.html">czm_pi</a></li><li><a href="czm_piOverFour.html">czm_piOverFour</a></li><li><a href="czm_piOverSix.html">czm_piOverSix</a></li><li><a href="czm_piOverThree.html">czm_piOverThree</a></li><li><a href="czm_piOverTwo.html">czm_piOverTwo</a></li><li><a href="czm_pointAlongRay.html">czm_pointAlongRay</a></li><li><a href="czm_projection.html">czm_projection</a></li><li><a href="czm_quadraticRealPolynomialRealRoots.html">czm_quadraticRealPolynomialRealRoots</a></li><li><a href="czm_quadraticRoots.html">czm_quadraticRoots</a></li><li><a href="czm_radiansPerDegree.html">czm_radiansPerDegree</a></li><li><a href="czm_ray.html">czm_ray</a></li><li><a href="czm_rayConeIntersectionInterval.html">czm_rayConeIntersectionInterval</a></li><li><a href="czm_rayConeIntersectNormal.html">czm_rayConeIntersectNormal</a></li><li><a href="czm_rayEllipsoidIntersectionInterval.html">czm_rayEllipsoidIntersectionInterval</a></li><li><a href="czm_rayEllipsoidSilhouetteConeIntersectionInterval.html">czm_rayEllipsoidSilhouetteConeIntersectionInterval</a></li><li><a href="czm_rayEllipsoidSilhouetteHalfspaceIntersectionInterval.html">czm_rayEllipsoidSilhouetteHalfspaceIntersectionInterval</a></li><li><a href="czm_rayHalfspaceIntersectionInterval.html">czm_rayHalfspaceIntersectionInterval</a></li><li><a href="czm_raySegment.html">czm_raySegment</a></li><li><a href="czm_raySegmentCollection.html">czm_raySegmentCollection</a></li><li><a href="czm_raySegmentCollectionCapacity.html">czm_raySegmentCollectionCapacity</a></li><li><a href="czm_raySegmentCollectionNew.html">czm_raySegmentCollectionNew</a></li><li><a href="czm_raySphereIntersectionInterval.html">czm_raySphereIntersectionInterval</a></li><li><a href="czm_removeAt.html">czm_removeAt</a></li><li><a href="czm_scene2D.html">czm_scene2D</a></li><li><a href="czm_scene3D.html">czm_scene3D</a></li><li><a href="czm_snoise.html">czm_snoise</a></li><li><a href="czm_sphere.html">czm_sphere</a></li><li><a href="czm_sphereNormal.html">czm_sphereNormal</a></li><li><a href="global.html#czm_subtraction">czm_subtraction</a></li><li><a href="czm_sunDirectionEC.html">czm_sunDirectionEC</a></li><li><a href="czm_sunDirectionWC.html">czm_sunDirectionWC</a></li><li><a href="czm_temeToPseudoFixed.html">czm_temeToPseudoFixed</a></li><li><a href="czm_threePiOver2.html">czm_threePiOver2</a></li><li><a href="czm_translateRelativeToEye.html">czm_translateRelativeToEye</a></li><li><a href="czm_transpose.html">czm_transpose</a></li><li><a href="czm_twoPi.html">czm_twoPi</a></li><li><a href="czm_view.html">czm_view</a></li><li><a href="czm_viewerPositionWC.html">czm_viewerPositionWC</a></li><li><a href="czm_viewport.html">czm_viewport</a></li><li><a href="czm_viewportOrthographic.html">czm_viewportOrthographic</a></li><li><a href="czm_viewportTransformation.html">czm_viewportTransformation</a></li><li><a href="czm_viewProjection.html">czm_viewProjection</a></li><li><a href="czm_viewRotation.html">czm_viewRotation</a></li><li><a href="czm_webMercatorMaxLatitude.html">czm_webMercatorMaxLatitude</a></li><li><a href="czm_windowToEyeCoordinates.html">czm_windowToEyeCoordinates</a></li></div></ul>
|
|
</div>
|
|
</div>
|
|
<div class="nav navStatic"></div>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Context</h1>
|
|
|
|
|
|
|
|
<section>
|
|
|
|
<header>
|
|
<h2>
|
|
Context
|
|
</h2>
|
|
|
|
</header>
|
|
|
|
<article>
|
|
<div class="container-overview">
|
|
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="Context"><span class="type-signature"></span>new Context</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: The browser does not support WebGL. Visit http://get.webgl.org.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: The browser supports WebGL, but initialization failed.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: canvas is required.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 171</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Methods</h3>
|
|
|
|
<dl>
|
|
|
|
<dt>
|
|
<h4 class="name" id="beginDraw"><span class="type-signature"></span>beginDraw</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2303</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="clear"><span class="type-signature"></span>clear</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Executes the specified clear command.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>clearCommand</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
ClearCommand
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
<td class="description last">The command with which to clear. If this parameter is undefined
|
|
or its clearState property is undefined, a default clear state is used.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>framebuffer</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="Framebuffer.html">Framebuffer</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
<td class="description last">The framebuffer to clear if one is not specified by the command.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2188</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li>Context#createClearState</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="continueDraw"><span class="type-signature"></span>continueDraw</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2340</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createCubeMap"><span class="type-signature"></span>createCubeMap</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA.
|
|
|
|
description.source can be {ImageData}, {HTMLImageElement}, {HTMLCanvasElement}, or {HTMLVideoElement}.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: description is required.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: description.source requires positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ faces.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Each face in description.sources must have the same width and height.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: description requires a source field to create an initialized cube map or width and height fields to create a blank cube map.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width must equal height.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width and height must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width and height must be less than or equal to the maximum cube map size.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid description.pixelFormat.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: description.pixelFormat cannot be DEPTH_COMPONENT or DEPTH_STENCIL.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid description.pixelDatatype.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="CubeMap.html">CubeMap</a></span>
|
|
|
|
DOC_TBA.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1574</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createTexture2D">Context#createTexture2D</a></li>
|
|
|
|
<li><a href="Context.html#createTexture2DFromFramebuffer">Context#createTexture2DFromFramebuffer</a></li>
|
|
|
|
<li><a href="Context.html#createSampler">Context#createSampler</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createFramebuffer"><span class="type-signature"></span>createFramebuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a framebuffer with optional initial color, depth, and stencil attachments.
|
|
Framebuffers are used for render-to-texture effects; they allow us to render to
|
|
a texture in one pass, and read from it in a later pass.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Object
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
<td class="description last">The initial framebuffer attachments as shown in Example 2. The possible properties are <code>colorTexture</code>, <code>colorRenderbuffer</code>, <code>depthTexture</code>, <code>depthRenderbuffer</code>, <code>stencilRenderbuffer</code>, <code>depthStencilTexture</code>, and <code>depthStencilRenderbuffer</code>.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Cannot have both a color texture and color renderbuffer attachment.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Cannot have both a depth texture and depth renderbuffer attachment.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Cannot have both a depth-stencil texture and depth-stencil renderbuffer attachment.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Cannot have both a depth and depth-stencil renderbuffer.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Cannot have both a stencil and depth-stencil renderbuffer.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Cannot have both a depth and stencil renderbuffer.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: The color-texture pixel-format must be a color format.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: The depth-texture pixel-format must be DEPTH_COMPONENT.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: The depth-stencil-texture pixel-format must be DEPTH_STENCIL.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="Framebuffer.html">Framebuffer</a></span>
|
|
|
|
The created framebuffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Create a framebuffer with no initial attachments,
|
|
// and then add a color-texture attachment.
|
|
var framebuffer = context.createFramebuffer();
|
|
framebuffer.setColorTexture(context.createTexture2D({
|
|
width : 256,
|
|
height : 256,
|
|
}));
|
|
|
|
//////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Create a framebuffer with color and depth texture attachments.
|
|
var width = context.getCanvas().clientWidth;
|
|
var height = context.getCanvas().clientHeight;
|
|
var framebuffer = context.createFramebuffer({
|
|
colorTexture : context.createTexture2D({
|
|
width : width,
|
|
height : height,
|
|
pixelFormat : PixelFormat.RGBA
|
|
}),
|
|
depthTexture : context.createTexture2D({
|
|
width : width,
|
|
height : height,
|
|
pixelFormat : PixelFormat.DEPTH_COMPONENT,
|
|
pixelDatatype : PixelDatatype.UNSIGNED_SHORT
|
|
})
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1732</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createTexture2D">Context#createTexture2D</a></li>
|
|
|
|
<li><a href="Context.html#createCubeMap">Context#createCubeMap</a></li>
|
|
|
|
<li><a href="Context.html#createRenderbuffer">Context#createRenderbuffer</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createIndexBuffer"><span class="type-signature"></span>createIndexBuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates an index buffer, which contains typed indices in GPU-controlled memory.
|
|
<br /><br />
|
|
An index buffer can be attached to a vertex array to select vertices for rendering.
|
|
<code>Context.draw</code> can render using the entire index buffer or a subset
|
|
of the index buffer defined by an offset and count.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>typedArrayOrSizeInBytes</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
ArrayBufferView
|
|
|
|
|
|
|
Number
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
|
|
<td class="description last">A typed array containing the data to copy to the buffer, or a <code>Number</code> defining the size of the buffer in bytes.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>usage</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="BufferUsage.html">BufferUsage</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
|
|
<td class="description last">Specifies the expected usage pattern of the buffer. On some GL implementations, this can significantly affect performance. See <a href="BufferUsage.html">BufferUsage</a>.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>indexDatatype</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="IndexDatatype.html">IndexDatatype</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
|
|
<td class="description last">The datatype of indices in the buffer.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: The size in bytes must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid <code>usage</code>.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid <code>indexDatatype</code>.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">IndexBuffer</span>
|
|
|
|
The index buffer, ready to be attached to a vertex array.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Create a stream index buffer of unsigned shorts that is
|
|
// 16 bytes in size.
|
|
var buffer = context.createIndexBuffer(16, BufferUsage.STREAM_DRAW,
|
|
IndexDatatype.UNSIGNED_SHORT);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Create a static index buffer containing three unsigned shorts.
|
|
var buffer = context.createIndexBuffer(new Uint16Array([0, 1, 2]),
|
|
BufferUsage.STATIC_DRAW, IndexDatatype.UNSIGNED_SHORT)</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1221</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createVertexArray">Context#createVertexArray</a></li>
|
|
|
|
<li><a href="Context.html#createVertexBuffer">Context#createVertexBuffer</a></li>
|
|
|
|
<li><a href="Context.html#draw">Context#draw</a></li>
|
|
|
|
<li><a href="VertexArray.html">VertexArray</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGenBuffer.xml'>glGenBuffer</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glBindBuffer.xml'>glBindBuffer</a> with <code>ELEMENT_ARRAY_BUFFER</code></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glBufferData.xml'>glBufferData</a> with <code>ELEMENT_ARRAY_BUFFER</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createPickFramebuffer"><span class="type-signature"></span>createPickFramebuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2722</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li>Context#pick</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createPickId"><span class="type-signature"></span>createPickId</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2744</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getObjectByPickId">Context#getObjectByPickId</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createRenderbuffer"><span class="type-signature"></span>createRenderbuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Object
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
<td class="description last">DOC_TBA.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid format.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width must be less than or equal to the maximum renderbuffer size.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Height must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Height must be less than or equal to the maximum renderbuffer size.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">createRenderbuffer</span>
|
|
|
|
DOC_TBA.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1753</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createFramebuffer">Context#createFramebuffer</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createRenderState"><span class="type-signature"></span>createRenderState</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA.
|
|
|
|
Validates and adds defaults for missing states.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: renderState.lineWidth is out of range.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.frontFace.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.cull.face.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: scissorTest.rectangle.width and scissorTest.rectangle.height must be greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.depthRange.near can't be greater than renderState.depthRange.far.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.depthRange.near must be greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.depthRange.far must be less than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.depthTest.func.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.blending.color components must be greater than or equal to zero and less than or equal to one
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.blending.equationRgb.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.blending.equationAlpha.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.blending.functionSourceRgb.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.blending.functionSourceAlpha.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.blending.functionDestinationRgb.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.blending.functionDestinationAlpha.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.frontFunction.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.backFunction.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.frontOperation.fail.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.frontOperation.zFail.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.frontOperation.zPass.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.backOperation.fail.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.backOperation.zFail.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid renderState.stencilTest.backOperation.zPass.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.viewport.width must be greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.viewport.width must be less than or equal to the maximum viewport width.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.viewport.height must be greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: renderState.viewport.height must be less than or equal to the maximum viewport height.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1819</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createSampler"><span class="type-signature"></span>createSampler</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid sampler.wrapS.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid sampler.wrapT.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid sampler.minificationFilter.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid sampler.magnificationFilter.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2053</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createTexture2D">Context#createTexture2D</a></li>
|
|
|
|
<li><a href="Context.html#createCubeMap">Context#createCubeMap</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createShaderProgram"><span class="type-signature"></span>createShaderProgram</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a shader program given the GLSL source for a vertex and fragment shader.
|
|
<br /><br />
|
|
The vertex and fragment shader are individually compiled, and then linked together
|
|
to create a shader program. An exception is thrown if any errors are encountered,
|
|
as described below.
|
|
<br /><br />
|
|
The program's active uniforms and attributes are queried and can be accessed using
|
|
the returned shader program. The caller can explicitly define the vertex
|
|
attribute indices using the optional <code>attributeLocations</code> argument as
|
|
shown in example two below.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>vertexShaderSource</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
String
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The GLSL source for the vertex shader.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>fragmentShaderSource</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
String
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The GLSL source for the fragment shader.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>attributeLocations</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Object
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
undefined
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">An optional object that maps vertex attribute names to indices for use with vertex arrays.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: Vertex shader failed to compile.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: Fragment shader failed to compile.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: Program failed to link.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="ShaderProgram.html">ShaderProgram</a></span>
|
|
|
|
The compiled and linked shader program, ready for use in a draw call.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Create a shader program allowing the GL to determine
|
|
// attribute indices.
|
|
var vs = 'attribute vec4 position; void main() { gl_Position = position; }';
|
|
var fs = 'void main() { gl_FragColor = vec4(1.0); }';
|
|
var sp = context.createShaderProgram(vs, fs);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Create a shader program with explicit attribute indices.
|
|
var vs = 'attribute vec4 position;' +
|
|
'attribute vec3 normal;' +
|
|
'void main() { ... }';
|
|
var fs = 'void main() { gl_FragColor = vec4(1.0); }';
|
|
var attributes = {
|
|
position : 0,
|
|
normal : 1
|
|
};
|
|
sp = context.createShaderProgram(vs, fs, attributes); *</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1113</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#draw">Context#draw</a></li>
|
|
|
|
<li><a href="Context.html#createVertexArray">Context#createVertexArray</a></li>
|
|
|
|
<li><a href="Context.html#getShaderCache">Context#getShaderCache</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glCreateShader.xml'>glCreateShader</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glShaderSource.xml'>glShaderSource</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glCompileShader.xml'>glCompileShader</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glCreateProgram.xml'>glCreateProgram</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glAttachShader.xml'>glAttachShader</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glLinkProgram.xml'>glLinkProgram</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetShaderiv.xml'>glGetShaderiv</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetActiveUniform.xml'>glGetActiveUniform</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetUniformLocation.xml'>glGetUniformLocation</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetUniform.xml'>glGetUniform</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glBindAttribLocation.xml'>glBindAttribLocation</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetActiveAttrib.xml'>glGetActiveAttrib</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetAttribLocation.xml'>glGetAttribLocation</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createTexture2D"><span class="type-signature"></span>createTexture2D</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA.
|
|
|
|
description.source can be {ImageData}, {HTMLImageElement}, {HTMLCanvasElement}, or {HTMLVideoElement}.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: When description.pixelFormat is DEPTH_COMPONENT or DEPTH_STENCIL, this WebGL implementation must support WEBGL_depth_texture.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: description is required.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: description requires a source field to create an initialized texture or width and height fields to create a blank texture.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Width must be less than or equal to the maximum texture size.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Height must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Height must be less than or equal to the maximum texture size.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid description.pixelFormat.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid description.pixelDatatype.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: When description.pixelFormat is DEPTH_COMPONENT, description.pixelDatatype must be UNSIGNED_SHORT or UNSIGNED_INT.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: When description.pixelFormat is DEPTH_STENCIL, description.pixelDatatype must be UNSIGNED_INT_24_8_WEBGL.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: When description.pixelFormat is DEPTH_COMPONENT or DEPTH_STENCIL, source cannot be provided.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="Texture.html">Texture</a></span>
|
|
|
|
DOC_TBA.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1367</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createTexture2DFromFramebuffer">Context#createTexture2DFromFramebuffer</a></li>
|
|
|
|
<li><a href="Context.html#createCubeMap">Context#createCubeMap</a></li>
|
|
|
|
<li><a href="Context.html#createSampler">Context#createSampler</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createTexture2DFromFramebuffer"><span class="type-signature"></span>createTexture2DFromFramebuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a texture, and copies a subimage of the framebuffer to it. When called without arguments,
|
|
the texture is the same width and height as the framebuffer and contains its contents.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>pixelFormat</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="PixelFormat.html">PixelFormat</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
PixelFormat.RGB
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The texture's internal pixel format.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>framebufferXOffset</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="PixelFormat.html">PixelFormat</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
0
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">An offset in the x direction in the framebuffer where copying begins from.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>framebufferYOffset</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="PixelFormat.html">PixelFormat</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
0
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">An offset in the y direction in the framebuffer where copying begins from.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>width</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="PixelFormat.html">PixelFormat</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
canvas.clientWidth
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The width of the texture in texels.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>height</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="PixelFormat.html">PixelFormat</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
canvas.clientHeight
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The height of the texture in texels.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid pixelFormat.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: pixelFormat cannot be DEPTH_COMPONENT or DEPTH_STENCIL.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: framebufferXOffset must be greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: framebufferYOffset must be greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: framebufferXOffset + width must be less than or equal to getCanvas().clientWidth.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: framebufferYOffset + height must be less than or equal to getCanvas().clientHeight.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="Texture.html">Texture</a></span>
|
|
|
|
A texture with contents from the framebuffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Create a texture with the contents of the framebuffer.
|
|
var t = context.createTexture2DFromFramebuffer();</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1486</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createTexture2D">Context#createTexture2D</a></li>
|
|
|
|
<li><a href="Context.html#createCubeMap">Context#createCubeMap</a></li>
|
|
|
|
<li><a href="Context.html#createSampler">Context#createSampler</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createTextureAtlas"><span class="type-signature"></span>createTextureAtlas</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a new texture atlas with this context.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description.pixelFormat</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="PixelFormat.html">PixelFormat</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
PixelFormat.RGBA
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The pixel format of the texture.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description.borderWidthInPixels</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Number
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
1
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The amount of spacing between adjacent images in pixels.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description.initialSize</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="Cartesian2.html">Cartesian2</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
new Cartesian2(16.0, 16.0)
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">The initial side lengths of the texture.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description.images</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Array
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
undefined
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">Array of Image to be added to the atlas. Same as calling addImages(images).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>description.image</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Image
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
undefined
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">Single image to be added to the atlas. Same as calling addImage(image).</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="TextureAtlas.html">TextureAtlas</a></span>
|
|
|
|
The new texture atlas.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1544</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="TextureAtlas.html">TextureAtlas</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createVertexArray"><span class="type-signature"></span>createVertexArray</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a vertex array, which defines the attributes making up a vertex, and contains an optional index buffer
|
|
to select vertices for rendering. Attributes are defined using object literals as shown in Example 1 below.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>attributes</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Array
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
undefined
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">An optional array of attributes.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>indexBuffer</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
IndexBuffer
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
undefined
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">An optional index buffer.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Attribute must have a <code>vertexBuffer</code>.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Attribute must have a <code>componentsPerAttribute</code>.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Attribute must have a valid <code>componentDatatype</code> or not specify it.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Attribute must have a <code>strideInBytes</code> less than or equal to 255 or not specify it.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Index n is used by more than one attribute.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="VertexArray.html">VertexArray</a></span>
|
|
|
|
The vertex array, ready for use with drawing.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Create a vertex array with vertices made up of three floating point
|
|
// values, e.g., a position, from a single vertex buffer. No index buffer is used.
|
|
var positionBuffer = context.createVertexBuffer(12, BufferUsage.STATIC_DRAW);
|
|
var attributes = [
|
|
{
|
|
index : 0,
|
|
enabled : true,
|
|
vertexBuffer : positionBuffer,
|
|
componentsPerAttribute : 3,
|
|
componentDatatype : ComponentDatatype.FLOAT,
|
|
normalize : false,
|
|
offsetInBytes : 0,
|
|
strideInBytes : 0 // tightly packed
|
|
}
|
|
];
|
|
var va = context.createVertexArray(attributes);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Create a vertex array with vertices from two different vertex buffers.
|
|
// Each vertex has a three-component position and three-component normal.
|
|
var positionBuffer = context.createVertexBuffer(12, BufferUsage.STATIC_DRAW);
|
|
var normalBuffer = context.createVertexBuffer(12, BufferUsage.STATIC_DRAW);
|
|
var attributes = [
|
|
{
|
|
index : 0,
|
|
vertexBuffer : positionBuffer,
|
|
componentsPerAttribute : 3,
|
|
componentDatatype : ComponentDatatype.FLOAT
|
|
},
|
|
{
|
|
index : 1,
|
|
vertexBuffer : normalBuffer,
|
|
componentsPerAttribute : 3,
|
|
componentDatatype : ComponentDatatype.FLOAT
|
|
}
|
|
];
|
|
var va = context.createVertexArray(attributes);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 3. Creates the same vertex layout as Example 2 using a single
|
|
// vertex buffer, instead of two.
|
|
var buffer = context.createVertexBuffer(24, BufferUsage.STATIC_DRAW);
|
|
var attributes = [
|
|
{
|
|
vertexBuffer : buffer,
|
|
componentsPerAttribute : 3,
|
|
componentDatatype : ComponentDatatype.FLOAT,
|
|
offsetInBytes : 0,
|
|
strideInBytes : 24
|
|
},
|
|
{
|
|
vertexBuffer : buffer,
|
|
componentsPerAttribute : 3,
|
|
componentDatatype : ComponentDatatype.FLOAT,
|
|
normalize : true,
|
|
offsetInBytes : 12,
|
|
strideInBytes : 24
|
|
}
|
|
];
|
|
var va = context.createVertexArray(attributes);</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1337</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createVertexArrayFromMesh">Context#createVertexArrayFromMesh</a></li>
|
|
|
|
<li><a href="Context.html#createVertexBuffer">Context#createVertexBuffer</a></li>
|
|
|
|
<li><a href="Context.html#createIndexBuffer">Context#createIndexBuffer</a></li>
|
|
|
|
<li><a href="Context.html#draw">Context#draw</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createVertexArrayFromMesh"><span class="type-signature"></span>createVertexArrayFromMesh</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a vertex array from a mesh. A mesh contains vertex attributes and optional index data
|
|
in system memory, whereas a vertex array contains vertex buffers and an optional index buffer in WebGL
|
|
memory for use with rendering.
|
|
<br /><br />
|
|
The <code>mesh</code> argument should use the standard layout like the mesh returned by <a href="BoxTessellator.html">BoxTessellator</a>.
|
|
<br /><br />
|
|
<code>creationArguments</code> can have four properties:
|
|
<ul>
|
|
<li><code>mesh</code>: The source mesh containing data used to create the vertex array.</li>
|
|
<li><code>attributeIndices</code>: An object that maps mesh attribute names to vertex shader attribute indices.</li>
|
|
<li><code>bufferUsage</code>: The expected usage pattern of the vertex array's buffers. On some WebGL implementations, this can significantly affect performance. See <a href="BufferUsage.html">BufferUsage</a>. Default: <code>BufferUsage.DYNAMIC_DRAW</code>.</li>
|
|
<li><code>vertexLayout</code>: Determines if all attributes are interleaved in a single vertex buffer or if each attribute is stored in a separate vertex buffer. Default: <code>VertexLayout.SEPARATE</code>.</li>
|
|
</ul>
|
|
<br />
|
|
If <code>creationArguments</code> is not specified or the <code>mesh</code> contains no data, the returned vertex array is empty.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>creationArguments</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
Object
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="default">
|
|
|
|
undefined
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">An object defining the mesh, attribute indices, buffer usage, and vertex layout used to create the vertex array.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
|
|
|
: Each attribute list must have the same number of vertices.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: The mesh must have zero or one index lists.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Index n is used by more than one attribute.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Creates a vertex array for rendering a box. The default dynamic draw
|
|
// usage is used for the created vertex and index buffer. The attributes are not
|
|
// interleaved by default.
|
|
var mesh = BoxTessellator.compute();
|
|
var va = context.createVertexArrayFromMesh({
|
|
mesh : mesh,
|
|
attributeIndices : MeshFilters.createAttributeIndices(mesh),
|
|
});
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Creates a vertex array with interleaved attributes in a
|
|
// single vertex buffer. The vertex and index buffer have static draw usage.
|
|
var va = context.createVertexArrayFromMesh({
|
|
mesh : mesh,
|
|
attributeIndices : MeshFilters.createAttributeIndices(mesh),
|
|
bufferUsage : BufferUsage.STATIC_DRAW,
|
|
vertexLayout : VertexLayout.INTERLEAVED
|
|
});
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 3. When the caller destroys the vertex array, it also destroys the
|
|
// attached vertex buffer(s) and index buffer.
|
|
va = va.destroy();</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2693</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createVertexArray">Context#createVertexArray</a></li>
|
|
|
|
<li><a href="Context.html#createVertexBuffer">Context#createVertexBuffer</a></li>
|
|
|
|
<li><a href="Context.html#createIndexBuffer">Context#createIndexBuffer</a></li>
|
|
|
|
<li><a href="MeshFilters.html#createAttributeIndices">MeshFilters.createAttributeIndices</a></li>
|
|
|
|
<li><a href="ShaderProgram.html">ShaderProgram</a></li>
|
|
|
|
<li><a href="BoxTessellator.html">BoxTessellator</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="createVertexBuffer"><span class="type-signature"></span>createVertexBuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Creates a vertex buffer, which contains untyped vertex data in GPU-controlled memory.
|
|
<br /><br />
|
|
A vertex array defines the actual makeup of a vertex, e.g., positions, normals, texture coordinates,
|
|
etc., by interpreting the raw data in one or more vertex buffers.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>typedArrayOrSizeInBytes</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
ArrayBufferView
|
|
|
|
|
|
|
Number
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
|
|
<td class="description last">A typed array containing the data to copy to the buffer, or a <code>Number</code> defining the size of the buffer in bytes.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>usage</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="BufferUsage.html">BufferUsage</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
|
|
<td class="description last">Specifies the expected usage pattern of the buffer. On some GL implementations, this can significantly affect performance. See <a href="BufferUsage.html">BufferUsage</a>.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: The size in bytes must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Invalid <code>usage</code>.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">VertexBuffer</span>
|
|
|
|
The vertex buffer, ready to be attached to a vertex array.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Create a dynamic vertex buffer 16 bytes in size.
|
|
var buffer = context.createVertexBuffer(16, BufferUsage.DYNAMIC_DRAW);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Create a dynamic vertex buffer from three floating-point values.
|
|
// The data copied to the vertex buffer is considered raw bytes until it is
|
|
// interpreted as vertices using a vertex array.
|
|
var positionBuffer = context.createVertexBuffer(new Float32Array([0, 0, 0]),
|
|
BufferUsage.STATIC_DRAW);</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1178</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createVertexArray">Context#createVertexArray</a></li>
|
|
|
|
<li><a href="Context.html#createIndexBuffer">Context#createIndexBuffer</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGenBuffer.xml'>glGenBuffer</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glBindBuffer.xml'>glBindBuffer</a> with <code>ARRAY_BUFFER</code></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glBufferData.xml'>glBufferData</a> with <code>ARRAY_BUFFER</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="draw"><span class="type-signature"></span>draw</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Executes the specified draw command.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
|
|
<th>Name</th>
|
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th>Argument</th>
|
|
|
|
|
|
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>drawCommand</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
DrawCommand
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
<td class="description last">The command with which to draw.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>framebuffer</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
<a href="Framebuffer.html">Framebuffer</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="attributes">
|
|
|
|
<optional><br>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
|
|
<td class="description last">The framebuffer to which to draw if one is not specified by the command.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: drawCommand is required.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: drawCommand.primitiveType is required and must be valid.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: drawCommand.shaderProgram is required.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: drawCommand.vertexArray is required.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: drawCommand.offset must be omitted or greater than or equal to zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Program validation failed.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: Framebuffer is not complete.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre class="code brush: js">// Example 1. Draw a single triangle specifying only required arguments
|
|
context.draw({
|
|
primitiveType : PrimitiveType.TRIANGLES,
|
|
shaderProgram : sp,
|
|
vertexArray : va,
|
|
});
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Example 2. Draw a single triangle specifying every argument
|
|
context.draw({
|
|
primitiveType : PrimitiveType.TRIANGLES,
|
|
offset : 0,
|
|
count : 3,
|
|
framebuffer : fb,
|
|
shaderProgram : sp,
|
|
vertexArray : va,
|
|
renderState : rs
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2292</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createShaderProgram">Context#createShaderProgram</a></li>
|
|
|
|
<li><a href="Context.html#createVertexArray">Context#createVertexArray</a></li>
|
|
|
|
<li><a href="Context.html#createFramebuffer">Context#createFramebuffer</a></li>
|
|
|
|
<li><a href="Context.html#createRenderState">Context#createRenderState</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="endDraw"><span class="type-signature"></span>endDraw</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2398</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getAlphaBits"><span class="type-signature"></span>getAlphaBits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the number of alpha bits per component in the default framebuffer's color buffer. The minimum is eight.
|
|
<br /><br />
|
|
The alpha channel is used for GL destination alpha operations and by the HTML compositor to combine the color buffer
|
|
with the rest of the page.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The number of alpha bits per component in the color buffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 579</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>ALPHA_BITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getBlueBits"><span class="type-signature"></span>getBlueBits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the number of blue bits per component in the default framebuffer's color buffer. The minimum is eight.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The number of blue bits per component in the color buffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 564</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>BLUE_BITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getCanvas"><span class="type-signature"></span>getCanvas</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the canvas assoicated with this context.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">HTMLCanvasElement</span>
|
|
|
|
The canvas assoicated with this context.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 457</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getDefaultCubeMap"><span class="type-signature"></span>getDefaultCubeMap</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns a cube map, where each face is a 1x1 RGBA texture initialized to
|
|
[255, 255, 255, 255]. This can be used as a placeholder cube map while
|
|
other cube maps are downloaded.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1029</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getDefaultTexture"><span class="type-signature"></span>getDefaultTexture</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns a 1x1 RGBA texture initialized to [255, 255, 255, 255]. This can
|
|
be used as a placeholder texture while other textures are downloaded.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 1006</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getDepthBits"><span class="type-signature"></span>getDepthBits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the number of depth bits per pixel in the default bound framebuffer. The minimum is 16 bits; most
|
|
implementations will have 24 bits.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The number of depth bits per pixel in the default bound framebuffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 592</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>DEPTH_BITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getDepthTexture"><span class="type-signature"></span>getDepthTexture</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns <code>true</code> if WEBGL_depth_texture is supported. This extension provides
|
|
access to depth textures that, for example, can be attached to framebuffers for shadow mapping.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
<code>true</code> if WEBGL_depth_texture is supported; otherwise, <code>false</code>.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 871</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/'>WEBGL_depth_texture</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getGreenBits"><span class="type-signature"></span>getGreenBits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the number of green bits per component in the default framebuffer's color buffer. The minimum is eight.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The number of green bits per component in the color buffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 552</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>GREEN_BITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getId"><span class="type-signature"></span>getId</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns a unique ID for this context.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
A unique ID for this context.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 446</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getLogShaderCompilation"><span class="type-signature"></span>getLogShaderCompilation</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 983</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setLogShaderCompilation">Context#setLogShaderCompilation</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumAliasedLineWidth"><span class="type-signature"></span>getMaximumAliasedLineWidth</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum aliased line width, in pixels, supported by this WebGL implementation. It will be at least one.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum aliased line in pixels.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 785</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMinimumAliasedLineWidth">Context#getMinimumAliasedLineWidth</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>ALIASED_LINE_WIDTH_RANGE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumAliasedPointSize"><span class="type-signature"></span>getMaximumAliasedPointSize</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum aliased point size, in pixels, supported by this WebGL implementation. It will be at least one.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum aliased point size in pixels.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 813</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMinimumAliasedPointSize">Context#getMinimumAliasedPointSize</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>ALIASED_POINT_SIZE_RANGE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumCombinedTextureImageUnits"><span class="type-signature"></span>getMaximumCombinedTextureImageUnits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of texture units that can be used from the vertex and fragment
|
|
shader with this WebGL implementation. The minimum is eight. If both shaders access the
|
|
same texture unit, this counts as two texture units.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum supported texture image units.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 621</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumTextureImageUnits">Context#getMaximumTextureImageUnits</a></li>
|
|
|
|
<li><a href="Context.html#getMaximumVertexTextureImageUnits">Context#getMaximumVertexTextureImageUnits</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_COMBINED_TEXTURE_IMAGE_UNITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumCubeMapSize"><span class="type-signature"></span>getMaximumCubeMapSize</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the approximate maximum cube mape width and height supported by this WebGL implementation.
|
|
The minimum is 16, but most desktop and laptop implementations will support much larger sizes like 8,192.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The approximate maximum cube mape width and height.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 637</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createCubeMap">Context#createCubeMap</a></li>
|
|
|
|
<li><a href="Context.html#getMaximumTextureSize">Context#getMaximumTextureSize</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_CUBE_MAP_TEXTURE_SIZE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumFragmentUniformVectors"><span class="type-signature"></span>getMaximumFragmentUniformVectors</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of <code>vec4</code>, <code>ivec4</code>, and <code>bvec4</code>
|
|
uniforms that can be used by a fragment shader with this WebGL implementation. The minimum is 16.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum number of <code>vec4</code>, <code>ivec4</code>, and <code>bvec4</code> uniforms that can be used by a fragment shader.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 652</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumVertexUniformVectors">Context#getMaximumVertexUniformVectors</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_FRAGMENT_UNIFORM_VECTORS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumRenderbufferSize"><span class="type-signature"></span>getMaximumRenderbufferSize</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum renderbuffer width and height supported by this WebGL implementation.
|
|
The minimum is 16, but most desktop and laptop implementations will support much larger sizes like 8,192.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum renderbuffer width and height.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 682</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createRenderbuffer">Context#createRenderbuffer</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_RENDERBUFFER_SIZE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumTextureFilterAnisotropy"><span class="type-signature"></span>getMaximumTextureFilterAnisotropy</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 895</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getTextureFilterAnisotropic">Context#getTextureFilterAnisotropic</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumTextureImageUnits"><span class="type-signature"></span>getMaximumTextureImageUnits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of texture units that can be used from the fragment shader with this WebGL implementation. The minimum is eight.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum number of texture units that can be used from the fragment shader.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 667</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumCombinedTextureImageUnits">Context#getMaximumCombinedTextureImageUnits</a></li>
|
|
|
|
<li><a href="Context.html#getMaximumVertexTextureImageUnits">Context#getMaximumVertexTextureImageUnits</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_TEXTURE_IMAGE_UNITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumTextureSize"><span class="type-signature"></span>getMaximumTextureSize</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the approximate maximum texture width and height supported by this WebGL implementation.
|
|
The minimum is 64, but most desktop and laptop implementations will support much larger sizes like 8,192.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The approximate maximum texture width and height.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 698</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createTexture2D">Context#createTexture2D</a></li>
|
|
|
|
<li><a href="Context.html#getMaximumCubeMapSize">Context#getMaximumCubeMapSize</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_TEXTURE_SIZE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumVaryingVectors"><span class="type-signature"></span>getMaximumVaryingVectors</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of <code>vec4</code> varying variables supported by this WebGL implementation.
|
|
The minimum is eight. Matrices and arrays count as multiple <code>vec4</code>s.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
Returns the maximum number of <code>vec4</code> varying variables.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 712</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_VARYING_VECTORS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumVertexAttributes"><span class="type-signature"></span>getMaximumVertexAttributes</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of <code>vec4</code> vertex attributes supported by this WebGL implementation. The minimum is eight.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum number of <code>vec4</code> vertex attributes.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 726</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createVertexArray">Context#createVertexArray</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_VERTEX_ATTRIBS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumVertexTextureImageUnits"><span class="type-signature"></span>getMaximumVertexTextureImageUnits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of texture units that can be used from the vertex shader with this WebGL implementation.
|
|
The minimum is zero, which means the GL does not support vertex texture fetch.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum number of texture units that can be used from the vertex shader.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 742</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumCombinedTextureImageUnits">Context#getMaximumCombinedTextureImageUnits</a></li>
|
|
|
|
<li><a href="Context.html#getMaximumTextureImageUnits">Context#getMaximumTextureImageUnits</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_VERTEX_TEXTURE_IMAGE_UNITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumVertexUniformVectors"><span class="type-signature"></span>getMaximumVertexUniformVectors</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum number of <code>vec4</code>, <code>ivec4</code>, and <code>bvec4</code>
|
|
uniforms that can be used by a vertex shader with this WebGL implementation. The minimum is 16.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum number of <code>vec4</code>, <code>ivec4</code>, and <code>bvec4</code> uniforms that can be used by a vertex shader.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 757</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumFragmentUniformVectors">Context#getMaximumFragmentUniformVectors</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_VERTEX_UNIFORM_VECTORS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumViewportHeight"><span class="type-signature"></span>getMaximumViewportHeight</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum supported height of the viewport. It will be at least as large as the visible height of the associated canvas.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum supported height of the viewport.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 841</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumViewportHeight">Context#getMaximumViewportHeight</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_VIEWPORT_DIMS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMaximumViewportWidth"><span class="type-signature"></span>getMaximumViewportWidth</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the maximum supported width of the viewport. It will be at least as large as the visible width of the associated canvas.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The maximum supported width of the viewport.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 827</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumViewportHeight">Context#getMaximumViewportHeight</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>MAX_VIEWPORT_DIMS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMinimumAliasedLineWidth"><span class="type-signature"></span>getMinimumAliasedLineWidth</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the minimum aliased line width, in pixels, supported by this WebGL implementation. It will be at most one.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The minimum aliased line in pixels.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 771</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumAliasedLineWidth">Context#getMaximumAliasedLineWidth</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>ALIASED_LINE_WIDTH_RANGE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getMinimumAliasedPointSize"><span class="type-signature"></span>getMinimumAliasedPointSize</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the minimum aliased point size, in pixels, supported by this WebGL implementation. It will be at most one.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The minimum aliased point size in pixels.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 799</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getMaximumAliasedPointSize">Context#getMaximumAliasedPointSize</a></li>
|
|
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>ALIASED_POINT_SIZE_RANGE</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getObjectByPickId"><span class="type-signature"></span>getObjectByPickId</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2733</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createPickId">Context#createPickId</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getRedBits"><span class="type-signature"></span>getRedBits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the number of red bits per component in the default framebuffer's color buffer. The minimum is eight.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The number of red bits per component in the color buffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 540</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>RED_BITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getRenderer"><span class="type-signature"></span>getRenderer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the name of the renderer/configuration/hardware platform. For example, this may be the model of the
|
|
video card, e.g., 'GeForce 8800 GTS/PCI/SSE2', or the browser-dependent name of the GL implementation, e.g.
|
|
'Mozilla' or 'ANGLE.'
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
The name of the renderer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 528</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetString.xml'>glGetString</a> with <code>RENDERER</code>.</li>
|
|
|
|
<li><a href='http://code.google.com/p/angleproject/'>ANGLE</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getShaderCache"><span class="type-signature"></span>getShaderCache</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 468</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#createShaderProgram">Context#createShaderProgram</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getShadingLanguageVersion"><span class="type-signature"></span>getShadingLanguageVersion</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the version or release number for the shading language of the form WebGL<space>GLSL<space>ES<space><version number><space><vendor-specific information>.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
The version or release number for the shading language.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 500</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetString.xml'>glGetString</a> with <code>SHADING_LANGUAGE_VERSION</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getStandardDerivatives"><span class="type-signature"></span>getStandardDerivatives</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns <code>true</code> if the OES_standard_derivatives extension is supported. This
|
|
extension provides access to <code>dFdx<code>, <code>dFdy<code>, and <code>fwidth<code>
|
|
functions from GLSL. A shader using these functions still needs to explicitly enable the
|
|
extension with <code>#extension GL_OES_standard_derivatives : enable</code>.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
<code>true</code> if OES_standard_derivatives is supported; otherwise, <code>false</code>.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 857</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/registry/gles/extensions/OES/OES_standard_derivatives.txt'>OES_standard_derivatives</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getStencilBits"><span class="type-signature"></span>getStencilBits</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the number of stencil bits per pixel in the default bound framebuffer. The minimum is eight bits.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Number</span>
|
|
|
|
The number of stencil bits per pixel in the default bound framebuffer.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 604</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGet.xml'>glGet</a> with <code>STENCIL_BITS</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getTextureFilterAnisotropic"><span class="type-signature"></span>getTextureFilterAnisotropic</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
<code>true</code> if EXT_texture_filter_anisotropic is supported; otherwise, <code>false</code>.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 884</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/registry/webgl/extensions/EXT_texture_filter_anisotropic/'>EXT_texture_filter_anisotropic</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getThrowOnWebGLError"><span class="type-signature"></span>getThrowOnWebGLError</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 956</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setThrowOnWebGLError">Context#setThrowOnWebGLError</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getUniformState"><span class="type-signature"></span>getUniformState</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 476</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getValidateFramebuffer"><span class="type-signature"></span>getValidateFramebuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 906</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setValidateFramebuffer">Context#setValidateFramebuffer</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getValidateShaderProgram"><span class="type-signature"></span>getValidateShaderProgram</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 931</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setValidateShaderProgram">Context#setValidateShaderProgram</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getVendor"><span class="type-signature"></span>getVendor</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the company responsible for the WebGL implementation.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
The company responsible for the WebGL implementation.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 512</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetString.xml'>glGetString</a> with <code>VENDOR</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="getVersion"><span class="type-signature"></span>getVersion</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
Returns the WebGL version or release number of the form <WebGL><space><version number><space><vendor-specific information>.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
The WebGL version or release number.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 488</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href='http://www.khronos.org/opengles/sdk/2.0/docs/man/glGetString.xml'>glGetString</a> with <code>VERSION</code>.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="readPixels"><span class="type-signature"></span>readPixels</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Throws:</h5>
|
|
<ul>
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: readState.width must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
<div class="param-desc">
|
|
|
|
|
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
|
|
|
: readState.height must be greater than zero.
|
|
</div>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 2415</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="setLogShaderCompilation"><span class="type-signature"></span>setLogShaderCompilation</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 994</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#getLogShaderCompilation">Context#getLogShaderCompilation</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="setThrowOnWebGLError"><span class="type-signature"></span>setThrowOnWebGLError</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
<h5>Performance:</h5>
|
|
<p class="description">DOC_TBA: slow.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 971</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setValidateFramebuffer">Context#setValidateFramebuffer</a></li>
|
|
|
|
<li><a href="Context.html#setValidateShaderProgram">Context#setValidateShaderProgram</a></li>
|
|
|
|
<li><a href="Context.html#getThrowOnWebGLError">Context#getThrowOnWebGLError</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="setValidateFramebuffer"><span class="type-signature"></span>setValidateFramebuffer</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
<h5>Performance:</h5>
|
|
<p class="description">DOC_TBA: slow.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 920</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setValidateShaderProgram">Context#setValidateShaderProgram</a></li>
|
|
|
|
<li><a href="Context.html#getValidateFramebuffer">Context#getValidateFramebuffer</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<h4 class="name" id="setValidateShaderProgram"><span class="type-signature"></span>setValidateShaderProgram</h4>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
<p class="description">
|
|
DOC_TBA
|
|
</p>
|
|
|
|
|
|
|
|
<h5>Performance:</h5>
|
|
<p class="description">DOC_TBA: slow.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
<dt class="tag-source">Source:</dt>
|
|
<dd class="tag-source"><ul class="dummy"><li>../../Source/Renderer/Context.js, line 945</li></ul></dd>
|
|
|
|
-->
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="Context.html#setValidateFramebuffer">Context#setValidateFramebuffer</a></li>
|
|
|
|
<li><a href="Context.html#getValidateShaderProgram">Context#getValidateShaderProgram</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<div class="hr"></div>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
</section>
|
|
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Fri Jan 18 2013 11:21:32 GMT-0500 (EST)
|
|
</footer>
|
|
</div>
|
|
|
|
<br clear="both">
|
|
|
|
<script type="text/javascript">
|
|
codeview.classFilter.Init();
|
|
|
|
if (window.frameElement) {
|
|
document.body.className = "embedded";
|
|
var ele = document.createElement('a');
|
|
ele.className = "popout";
|
|
ele.target = "_blank";
|
|
ele.href = window.location.href;
|
|
ele.innerHTML = "»";
|
|
ele.title = "Pop out";
|
|
document.getElementById('main').appendChild(ele);
|
|
}
|
|
var searchTerm = (document.URL.split('='))[1];
|
|
var show = (document.URL.split('='))[2];
|
|
|
|
if (show) {
|
|
document.getElementById("filterType").value = show;
|
|
}
|
|
|
|
if(searchTerm){
|
|
searchTerm = searchTerm.split('&')[0] || '';
|
|
document.filterForm.classFilter.value = searchTerm;
|
|
}
|
|
else {
|
|
searchTerm="";
|
|
}
|
|
codeview.filter(searchTerm);
|
|
|
|
SyntaxHighlighter.all();
|
|
</script>
|
|
<script src="javascript/indexLinks.js"></script>
|
|
</body>
|
|
</html> |