<doc>
	<legacy_id></legacy_id>
	<name>compositorType</name>
	<type>property</type>

	<syntax>
		<example>set the compositorType of <i>stack</i> to <i>compositorType</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Specifies which compositor is used when rendering a stack.</summary>

	<examples>
<example>set the compositorType of this stack to &quot;software&quot;</example>
<example><p>put &quot;none&quot; into tCompositorType</p><p>set the compositorType of this stack to tCompositorType</p></example>
	</examples>

	<history>
		<introduced version="5.0">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		
	</history>

	<objects>
		<stack/>
	</objects>

	<platforms>
		<mac/>
		<windows/>
		<linux/>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<desktop/>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>Objects &amp; Messages</category>
		<category>Windows &amp; Dialog Boxes</category>
		<concept>display</concept>
	</classification>

	<references>
		<property tag="compositorCacheLimit">compositorCacheLimit Property</property>
		<property tag="compositorTileSize">compositorTileSize Property</property>
		<property tag="layerMode">layerMode Property</property>
	</references>

	<description>
	<overview>Use the <b>compositorType </b>property to specify which compositor is used when rendering your stack. Setting this property puts LiveCode into accelerated rendering mode which offers performance benefits, particularly when animating.</overview>

		<parameters>

  <parameter>
    <name>Stack</name>
    <description>The name or ID of the stack.</description>
  </parameter>
  <parameter>
    <name>compositorType</name>
    <description>A string containing the type of compositor to use. One of the following:</description>
    <options title="">
      <option>
        <item>empty (or 'none')</item>
        <description>Do not use accelerated rendering (the default).</description>
      </option>
      <option>
        <item>software</item>
        <description>Use the built-in rendering engine to composite.</description>
      </option>
      <option>
        <item>coregraphics</item>
        <description>Use CoreGraphics to composite (Mac / iOS only) (Recommended for Mac OS).</description>
      </option>
      <option>
        <item>opengl</item>
        <description>Use OpenGL to composite (iOS only).</description>
      </option>
    </options>
  </parameter>
		</parameters>

	<value></value>
	<comments><note></note>Set the compositor properties in a preOpenStack or preOpenCard handler - they are not persistent (not saved into the stackfile).</comments>
	</description>
</doc>