592 lines
31 KiB
HTML
592 lines
31 KiB
HTML
|
<!doctype html>
|
|||
|
|
<html class="default no-js">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|||
|
|
<title>Renderer | @esengine/egret-framework</title>
|
|||
|
|
<meta name="description" content="Documentation for @esengine/egret-framework">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|||
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<header>
|
|||
|
|
<div class="tsd-page-toolbar">
|
|||
|
|
<div class="container">
|
|||
|
|
<div class="table-wrap">
|
|||
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|||
|
|
<div class="field">
|
|||
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|||
|
|
<input id="tsd-search-field" type="text" />
|
|||
|
|
</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">@esengine/egret-framework</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>
|
|||
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|||
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|||
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|||
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<a href="../modules/_graphics_renderers_renderer_.html">"Graphics/Renderers/Renderer"</a>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<a href="../modules/_graphics_renderers_renderer_.es.html">es</a>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html">Renderer</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h1>Class Renderer</h1>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</header>
|
|||
|
|
<div class="container container-main">
|
|||
|
|
<div class="row">
|
|||
|
|
<div class="col-8 col-content">
|
|||
|
|
<section class="tsd-panel tsd-comment">
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>渲染器被添加到场景中并处理所有对RenderableComponent的实际调用</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-hierarchy">
|
|||
|
|
<h3>Hierarchy</h3>
|
|||
|
|
<ul class="tsd-hierarchy">
|
|||
|
|
<li>
|
|||
|
|
<span class="target">Renderer</span>
|
|||
|
|
<ul class="tsd-hierarchy">
|
|||
|
|
<li>
|
|||
|
|
<a href="_graphics_renderers_defaultrenderer_.es.defaultrenderer.html" class="tsd-signature-type">DefaultRenderer</a>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<a href="_graphics_renderers_renderlayerexcluderenderer_.es.renderlayerexcluderenderer.html" class="tsd-signature-type">RenderLayerExcludeRenderer</a>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<a href="_graphics_renderers_screenspacerenderer_.es.screenspacerenderer.html" class="tsd-signature-type">ScreenSpaceRenderer</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</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 tsd-is-private-protected">
|
|||
|
|
<h3>Constructors</h3>
|
|||
|
|
<ul class="tsd-index-list">
|
|||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-protected"><a href="_graphics_renderers_renderer_.es.renderer.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-index-section ">
|
|||
|
|
<h3>Properties</h3>
|
|||
|
|
<ul class="tsd-index-list">
|
|||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#camera" class="tsd-kind-icon">camera</a></li>
|
|||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#renderorder" class="tsd-kind-icon">render<wbr>Order</a></li>
|
|||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#rendertexture" class="tsd-kind-icon">render<wbr>Texture</a></li>
|
|||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#shoulddebugrender" class="tsd-kind-icon">should<wbr>Debug<wbr>Render</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-index-section ">
|
|||
|
|
<h3>Accessors</h3>
|
|||
|
|
<ul class="tsd-index-list">
|
|||
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#wantstorendertoscenerendertarget" class="tsd-kind-icon">wants<wbr>ToRender<wbr>ToScene<wbr>Render<wbr>Target</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-index-section ">
|
|||
|
|
<h3>Methods</h3>
|
|||
|
|
<ul class="tsd-index-list">
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_graphics_renderers_renderer_.es.renderer.html#beginrender" class="tsd-kind-icon">begin<wbr>Render</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#compareto" class="tsd-kind-icon">compare<wbr>To</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_graphics_renderers_renderer_.es.renderer.html#debugrender" class="tsd-kind-icon">debug<wbr>Render</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#onaddedtoscene" class="tsd-kind-icon">on<wbr>Added<wbr>ToScene</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#onscenebackbuffersizechanged" class="tsd-kind-icon">on<wbr>Scene<wbr>Back<wbr>Buffer<wbr>Size<wbr>Changed</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#render" class="tsd-kind-icon">render</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_graphics_renderers_renderer_.es.renderer.html#renderafterstatecheck" class="tsd-kind-icon">render<wbr>After<wbr>State<wbr>Check</a></li>
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_graphics_renderers_renderer_.es.renderer.html#unload" class="tsd-kind-icon">unload</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
|
|||
|
|
<h2>Constructors</h2>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|||
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Renderer<span class="tsd-signature-symbol">(</span>renderOrder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, camera<span class="tsd-signature-symbol">?: </span><a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_graphics_renderers_renderer_.es.renderer.html" class="tsd-signature-type">Renderer</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L32">src/Graphics/Renderers/Renderer.ts:32</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>renderOrder: <span class="tsd-signature-type">number</span></h5>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> camera: <a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol"> = null</span></h5>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <a href="_graphics_renderers_renderer_.es.renderer.html" class="tsd-signature-type">Renderer</a></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</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-class">
|
|||
|
|
<a name="camera" class="tsd-anchor"></a>
|
|||
|
|
<h3>camera</h3>
|
|||
|
|
<div class="tsd-signature tsd-kind-icon">camera<span class="tsd-signature-symbol">:</span> <a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></div>
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L11">src/Graphics/Renderers/Renderer.ts:11</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>渲染器用于渲染的摄像机(实际上是用于剔除的变换矩阵和边界)
|
|||
|
|
不是必须的
|
|||
|
|
Renderer子类可以选择调用beginRender时使用的摄像头</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a name="renderorder" class="tsd-anchor"></a>
|
|||
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> render<wbr>Order</h3>
|
|||
|
|
<div class="tsd-signature tsd-kind-icon">render<wbr>Order<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L15">src/Graphics/Renderers/Renderer.ts:15</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>指定场景调用渲染器的顺序</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a name="rendertexture" class="tsd-anchor"></a>
|
|||
|
|
<h3>render<wbr>Texture</h3>
|
|||
|
|
<div class="tsd-signature tsd-kind-icon">render<wbr>Texture<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RenderTexture</span></div>
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L19">src/Graphics/Renderers/Renderer.ts:19</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>如果renderTarget不是null，这个渲染器将渲染到渲染目标而不是屏幕</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a name="shoulddebugrender" class="tsd-anchor"></a>
|
|||
|
|
<h3>should<wbr>Debug<wbr>Render</h3>
|
|||
|
|
<div class="tsd-signature tsd-kind-icon">should<wbr>Debug<wbr>Render<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L25">src/Graphics/Renderers/Renderer.ts:25</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>这个渲染器的标志，决定它是否应该调试渲染。
|
|||
|
|
render方法接收一个bool (debugRenderEnabled)，让渲染器知道全局调试渲染是否打开/关闭。
|
|||
|
|
渲染器然后使用本地bool来决定它是否应该调试渲染。</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|||
|
|
<h2>Accessors</h2>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|||
|
|
<a name="wantstorendertoscenerendertarget" class="tsd-anchor"></a>
|
|||
|
|
<h3>wants<wbr>ToRender<wbr>ToScene<wbr>Render<wbr>Target</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> wantsToRenderToSceneRenderTarget<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L30">src/Graphics/Renderers/Renderer.ts:30</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>如果为true，场景将使用场景渲染目标调用setRenderTarget。
|
|||
|
|
如果渲染器有渲染纹理，默认实现返回true</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|||
|
|
<h2>Methods</h2>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a name="beginrender" class="tsd-anchor"></a>
|
|||
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> begin<wbr>Render</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">begin<wbr>Render<span class="tsd-signature-symbol">(</span>cam<span class="tsd-signature-symbol">: </span><a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L71">src/Graphics/Renderers/Renderer.ts:71</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>cam: <a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></h5>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a name="compareto" class="tsd-anchor"></a>
|
|||
|
|
<h3>compare<wbr>To</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">compare<wbr>To<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="_graphics_renderers_renderer_.es.renderer.html" class="tsd-signature-type">Renderer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L63">src/Graphics/Renderers/Renderer.ts:63</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>other: <a href="_graphics_renderers_renderer_.es.renderer.html" class="tsd-signature-type">Renderer</a></h5>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a name="debugrender" class="tsd-anchor"></a>
|
|||
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> debug<wbr>Render</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">debug<wbr>Render<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="_ecs_scene_.es.scene.html" class="tsd-signature-type">Scene</a>, cam<span class="tsd-signature-symbol">: </span><a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L88">src/Graphics/Renderers/Renderer.ts:88</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>默认debugRender方法只循环遍历所有实体并调用entity.debugRender</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>scene: <a href="_ecs_scene_.es.scene.html" class="tsd-signature-type">Scene</a></h5>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<h5>cam: <a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></h5>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a name="onaddedtoscene" class="tsd-anchor"></a>
|
|||
|
|
<h3>on<wbr>Added<wbr>ToScene</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Added<wbr>ToScene<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="_ecs_scene_.es.scene.html" class="tsd-signature-type">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L43">src/Graphics/Renderers/Renderer.ts:43</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>当渲染器被添加到场景时调用</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>scene: <a href="_ecs_scene_.es.scene.html" class="tsd-signature-type">Scene</a></h5>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a name="onscenebackbuffersizechanged" class="tsd-anchor"></a>
|
|||
|
|
<h3>on<wbr>Scene<wbr>Back<wbr>Buffer<wbr>Size<wbr>Changed</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Scene<wbr>Back<wbr>Buffer<wbr>Size<wbr>Changed<span class="tsd-signature-symbol">(</span>newWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, newHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L59">src/Graphics/Renderers/Renderer.ts:59</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>当默认场景渲染目标被调整大小和当场景已经开始添加渲染器时调用</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>newWidth: <span class="tsd-signature-type">number</span></h5>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<h5>newHeight: <span class="tsd-signature-type">number</span></h5>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a name="render" class="tsd-anchor"></a>
|
|||
|
|
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> render</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="_ecs_scene_.es.scene.html" class="tsd-signature-type">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L52">src/Graphics/Renderers/Renderer.ts:52</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>scene: <a href="_ecs_scene_.es.scene.html" class="tsd-signature-type">Scene</a></h5>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a name="renderafterstatecheck" class="tsd-anchor"></a>
|
|||
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> render<wbr>After<wbr>State<wbr>Check</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">render<wbr>After<wbr>State<wbr>Check<span class="tsd-signature-symbol">(</span>renderable<span class="tsd-signature-symbol">: </span><a href="../interfaces/_graphics_renderers_irenderable_.es.irenderable.html" class="tsd-signature-type">IRenderable</a>, cam<span class="tsd-signature-symbol">: </span><a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L79">src/Graphics/Renderers/Renderer.ts:79</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|||
|
|
<ul class="tsd-parameters">
|
|||
|
|
<li>
|
|||
|
|
<h5>renderable: <a href="../interfaces/_graphics_renderers_irenderable_.es.irenderable.html" class="tsd-signature-type">IRenderable</a></h5>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<h5>cam: <a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></h5>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
</div>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a name="unload" class="tsd-anchor"></a>
|
|||
|
|
<h3>unload</h3>
|
|||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<li class="tsd-signature tsd-kind-icon">unload<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-descriptions">
|
|||
|
|
<li class="tsd-description">
|
|||
|
|
<aside class="tsd-sources">
|
|||
|
|
<ul>
|
|||
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/Renderer.ts#L49">src/Graphics/Renderers/Renderer.ts:49</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<div class="tsd-comment tsd-typography">
|
|||
|
|
<div class="lead">
|
|||
|
|
<p>当场景结束或渲染器从场景中移除时调用。使用这个进行清理。</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
</div>
|
|||
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|||
|
|
<nav class="tsd-navigation primary">
|
|||
|
|
<ul>
|
|||
|
|
<li class="globals ">
|
|||
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|||
|
|
</li>
|
|||
|
|
<li class="current tsd-kind-module">
|
|||
|
|
<a href="../modules/_graphics_renderers_renderer_.html">"<wbr>Graphics/<wbr>Renderers/<wbr>Renderer"</a>
|
|||
|
|
<ul>
|
|||
|
|
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
|||
|
|
<a href="../modules/_graphics_renderers_renderer_.es.html">es</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|||
|
|
<ul class="before-current">
|
|||
|
|
</ul>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html" class="tsd-kind-icon">Renderer</a>
|
|||
|
|
<ul>
|
|||
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#constructor" class="tsd-kind-icon">constructor</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#camera" class="tsd-kind-icon">camera</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#renderorder" class="tsd-kind-icon">render<wbr>Order</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#rendertexture" class="tsd-kind-icon">render<wbr>Texture</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#shoulddebugrender" class="tsd-kind-icon">should<wbr>Debug<wbr>Render</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#wantstorendertoscenerendertarget" class="tsd-kind-icon">wants<wbr>ToRender<wbr>ToScene<wbr>Render<wbr>Target</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#beginrender" class="tsd-kind-icon">begin<wbr>Render</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#compareto" class="tsd-kind-icon">compare<wbr>To</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#debugrender" class="tsd-kind-icon">debug<wbr>Render</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#onaddedtoscene" class="tsd-kind-icon">on<wbr>Added<wbr>ToScene</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#onscenebackbuffersizechanged" class="tsd-kind-icon">on<wbr>Scene<wbr>Back<wbr>Buffer<wbr>Size<wbr>Changed</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#render" class="tsd-kind-icon">render</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#renderafterstatecheck" class="tsd-kind-icon">render<wbr>After<wbr>State<wbr>Check</a>
|
|||
|
|
</li>
|
|||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|||
|
|
<a href="_graphics_renderers_renderer_.es.renderer.html#unload" class="tsd-kind-icon">unload</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="after-current">
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer class="with-border-bottom">
|
|||
|
|
<div class="container">
|
|||
|
|
<h2>Legend</h2>
|
|||
|
|
<div class="tsd-legend-group">
|
|||
|
|
<ul class="tsd-legend">
|
|||
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
|||
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-legend">
|
|||
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="tsd-legend">
|
|||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
<div class="container tsd-generator">
|
|||
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|||
|
|
</div>
|
|||
|
|
<div class="overlay"></div>
|
|||
|
|
<script src="../assets/js/main.js"></script>
|
|||
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|