<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>GPUDepthStencilState | Babylon.js API documentation</title><meta name="description" content="Documentation for Babylon.js API documentation"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Babylon.js API documentation</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">Babylon.js API documentation</a></li><li><a href="GPUDepthStencilState.html">GPUDepthStencilState</a></li></ul><h1>Interface GPUDepthStencilState </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">GPUDepthStencilState</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthBias" class="tsd-kind-icon">depth<wbr>Bias</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthBiasClamp" class="tsd-kind-icon">depth<wbr>Bias<wbr>Clamp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthBiasSlopeScale" class="tsd-kind-icon">depth<wbr>Bias<wbr>Slope<wbr>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthCompare" class="tsd-kind-icon">depth<wbr>Compare</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthWriteEnabled" class="tsd-kind-icon">depth<wbr>Write<wbr>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#format" class="tsd-kind-icon">format</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilBack" class="tsd-kind-icon">stencil<wbr>Back</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilFront" class="tsd-kind-icon">stencil<wbr>Front</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilReadMask" class="tsd-kind-icon">stencil<wbr>Read<wbr>Mask</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilWriteMask" class="tsd-kind-icon">stencil<wbr>Write<wbr>Mask</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="depthBias" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> depth<wbr>Bias<a href="#depthBias" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">depth<wbr>Bias<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97246</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="depthBiasClamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> depth<wbr>Bias<wbr>Clamp<a href="#depthBiasClamp" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">depth<wbr>Bias<wbr>Clamp<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97248</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="depthBiasSlopeScale" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> depth<wbr>Bias<wbr>Slope<wbr>Scale<a href="#depthBiasSlopeScale" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">depth<wbr>Bias<wbr>Slope<wbr>Scale<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97247</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="depthCompare" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> depth<wbr>Compare<a href="#depthCompare" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">depth<wbr>Compare<span class="tsd-signature-symbol">?:</span> <a href="../index.html#GPUCompareFunction" class="tsd-signature-type" data-tsd-kind="Type alias">GPUCompareFunction</a></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97238</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="depthWriteEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> depth<wbr>Write<wbr>Enabled<a href="#depthWriteEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">depth<wbr>Write<wbr>Enabled<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97237</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="format" class="tsd-anchor"></a><h3 class="tsd-anchor-link">format<a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <a href="../index.html#GPUTextureFormat" class="tsd-signature-type" data-tsd-kind="Type alias">GPUTextureFormat</a></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97235</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="stencilBack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> stencil<wbr>Back<a href="#stencilBack" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">stencil<wbr>Back<span class="tsd-signature-symbol">?:</span> <a href="GPUStencilStateFace.html" class="tsd-signature-type" data-tsd-kind="Interface">GPUStencilStateFace</a></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97241</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="stencilFront" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> stencil<wbr>Front<a href="#stencilFront" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">stencil<wbr>Front<span class="tsd-signature-symbol">?:</span> <a href="GPUStencilStateFace.html" class="tsd-signature-type" data-tsd-kind="Interface">GPUStencilStateFace</a></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97240</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="stencilReadMask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> stencil<wbr>Read<wbr>Mask<a href="#stencilReadMask" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">stencil<wbr>Read<wbr>Mask<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97243</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="stencilWriteMask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> stencil<wbr>Write<wbr>Mask<a href="#stencilWriteMask" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">stencil<wbr>Write<wbr>Mask<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:97244</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/BABYLON.html">BABYLON</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="GPUDepthStencilState.html" class="tsd-kind-icon">GPUDepth<wbr>Stencil<wbr>State</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthBias" class="tsd-kind-icon">depth<wbr>Bias</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthBiasClamp" class="tsd-kind-icon">depth<wbr>Bias<wbr>Clamp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthBiasSlopeScale" class="tsd-kind-icon">depth<wbr>Bias<wbr>Slope<wbr>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthCompare" class="tsd-kind-icon">depth<wbr>Compare</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#depthWriteEnabled" class="tsd-kind-icon">depth<wbr>Write<wbr>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#format" class="tsd-kind-icon">format</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilBack" class="tsd-kind-icon">stencil<wbr>Back</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilFront" class="tsd-kind-icon">stencil<wbr>Front</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilReadMask" class="tsd-kind-icon">stencil<wbr>Read<wbr>Mask</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GPUDepthStencilState.html#stencilWriteMask" class="tsd-kind-icon">stencil<wbr>Write<wbr>Mask</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div></body></html>

Interface GPUDepthStencilState

Hierarchy

Index

Properties

Properties

Optional depthBias Search playground for depthBias

Optional depthBiasClamp Search playground for depthBiasClamp

Optional depthBiasSlopeScale Search playground for depthBiasSlopeScale

Optional depthCompare Search playground for depthCompare

Optional depthWriteEnabled Search playground for depthWriteEnabled

format Search playground for format

Optional stencilBack Search playground for stencilBack

Optional stencilFront Search playground for stencilFront

Optional stencilReadMask Search playground for stencilReadMask

Optional stencilWriteMask Search playground for stencilWriteMask

Hierarchy

Index

Properties

Properties

Optional depthBiasSearch playground for depthBias

Optional depthBiasClampSearch playground for depthBiasClamp

Optional depthBiasSlopeScaleSearch playground for depthBiasSlopeScale

Optional depthCompareSearch playground for depthCompare

Optional depthWriteEnabledSearch playground for depthWriteEnabled

formatSearch playground for format

Optional stencilBackSearch playground for stencilBack

Optional stencilFrontSearch playground for stencilFront

Optional stencilReadMaskSearch playground for stencilReadMask

Optional stencilWriteMaskSearch playground for stencilWriteMask

Optional depthBias Search playground for depthBias

Optional depthBiasClamp Search playground for depthBiasClamp

Optional depthBiasSlopeScale Search playground for depthBiasSlopeScale

Optional depthCompare Search playground for depthCompare

Optional depthWriteEnabled Search playground for depthWriteEnabled

format Search playground for format

Optional stencilBack Search playground for stencilBack

Optional stencilFront Search playground for stencilFront

Optional stencilReadMask Search playground for stencilReadMask

Optional stencilWriteMask Search playground for stencilWriteMask