qd-changjing/public/static/Build/Documentation/global.html#StencilOperation

870 lines
59 KiB
Plaintext
Raw Normal View History

2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>StencilOperation - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
StencilOperation
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L8">Scene/StencilOperation.js 8</a>
</div>
<div class="description">Determines the action taken based on the result of the stencil test.</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ZERO</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Sets the stencil buffer value to zero.</td>
</tr>
<tr>
<td class="name"><code>KEEP</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Does not change the stencil buffer.</td>
</tr>
<tr>
<td class="name"><code>REPLACE</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Replaces the stencil buffer value with the reference value.</td>
</tr>
<tr>
<td class="name"><code>INCREMENT</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Increments the stencil buffer value, clamping to unsigned byte.</td>
</tr>
<tr>
<td class="name"><code>DECREMENT</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Decrements the stencil buffer value, clamping to zero.</td>
</tr>
<tr>
<td class="name"><code>INVERT</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Bitwise inverts the existing stencil buffer value.</td>
</tr>
<tr>
<td class="name"><code>INCREMENT_WRAP</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Increments the stencil buffer value, wrapping to zero when exceeding the unsigned byte range.</td>
</tr>
<tr>
<td class="name"><code>DECREMENT_WRAP</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Decrements the stencil buffer value, wrapping to the maximum unsigned byte instead of going below zero.</td>
</tr>
</tbody>
</table>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".DECREMENT">
<a href="#.DECREMENT" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.DECREMENT<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L47">Scene/StencilOperation.js 47</a>
</div>
</h4>
</div>
<div class="description">
Decrements the stencil buffer value, clamping to zero.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.DECR</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".DECREMENT_WRAP">
<a href="#.DECREMENT_WRAP" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.DECREMENT_WRAP<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L71">Scene/StencilOperation.js 71</a>
</div>
</h4>
</div>
<div class="description">
Decrements the stencil buffer value, wrapping to the maximum unsigned byte instead of going below zero.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.DECR_WRAP</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".INCREMENT">
<a href="#.INCREMENT" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.INCREMENT<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L39">Scene/StencilOperation.js 39</a>
</div>
</h4>
</div>
<div class="description">
Increments the stencil buffer value, clamping to unsigned byte.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.INCR</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".INCREMENT_WRAP">
<a href="#.INCREMENT_WRAP" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.INCREMENT_WRAP<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L63">Scene/StencilOperation.js 63</a>
</div>
</h4>
</div>
<div class="description">
Increments the stencil buffer value, wrapping to zero when exceeding the unsigned byte range.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.INCR_WRAP</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".INVERT">
<a href="#.INVERT" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.INVERT<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L55">Scene/StencilOperation.js 55</a>
</div>
</h4>
</div>
<div class="description">
Bitwise inverts the existing stencil buffer value.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.INVERT</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".KEEP">
<a href="#.KEEP" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.KEEP<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L23">Scene/StencilOperation.js 23</a>
</div>
</h4>
</div>
<div class="description">
Does not change the stencil buffer.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.KEEP</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".REPLACE">
<a href="#.REPLACE" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.REPLACE<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L31">Scene/StencilOperation.js 31</a>
</div>
</h4>
</div>
<div class="description">
Replaces the stencil buffer value with the reference value.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.REPLACE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".ZERO">
<a href="#.ZERO" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.StencilOperation.ZERO<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/StencilOperation.js#L15">Scene/StencilOperation.js 15</a>
</div>
</h4>
</div>
<div class="description">
Sets the stencil buffer value to zero.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">WebGLConstants.ZERO</code>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>