Context3DStencilAction - Adobe ActionScript® 3 (AS3 ) API Reference

Package	flash.display3D
Class	public final class Context3DStencilAction
Inheritance	Context3DStencilAction Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Defines the values to use for specifying stencil actions.

A stencil action specifies how the values in the stencil buffer should be changed.

Related API Elements

Context3D.setStencilActions()

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		DECREMENT_SATURATE : String = "decrementSaturate" [static] Decrement the stencil buffer value, clamping at 0, the minimum value.	Context3DStencilAction
		DECREMENT_WRAP : String = "decrementWrap" [static] Decrement the stencil buffer value.	Context3DStencilAction
		INCREMENT_SATURATE : String = "incrementSaturate" [static] Increment the stencil buffer value, clamping at 255, the maximum value.	Context3DStencilAction
		INCREMENT_WRAP : String = "incrementWrap" [static] Increment the stencil buffer value.	Context3DStencilAction
		INVERT : String = "invert" [static] Invert the stencil buffer value, bitwise.	Context3DStencilAction
		KEEP : String = "keep" [static] Keep the current stencil buffer value.	Context3DStencilAction
		SET : String = "set" [static] Replace the stencil buffer value with the reference value.	Context3DStencilAction
		ZERO : String = "zero" [static] Set the stencil buffer value to 0.	Context3DStencilAction

Constant Detail

DECREMENT_SATURATE

Constant

public static const DECREMENT_SATURATE:String = "decrementSaturate"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Decrement the stencil buffer value, clamping at 0, the minimum value.

DECREMENT_WRAP

Constant

public static const DECREMENT_WRAP:String = "decrementWrap"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Decrement the stencil buffer value. If the result is less than 0, the minimum value, then the buffer value is "wrapped around" to 255.

INCREMENT_SATURATE

Constant

public static const INCREMENT_SATURATE:String = "incrementSaturate"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Increment the stencil buffer value, clamping at 255, the maximum value.

INCREMENT_WRAP

Constant

public static const INCREMENT_WRAP:String = "incrementWrap"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Increment the stencil buffer value. If the result exceeds 255, the maximum value, then the buffer value is "wrapped around" to 0.

INVERT

Constant

public static const INVERT:String = "invert"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Invert the stencil buffer value, bitwise.

For example, if the 8-bit binary number in the stencil buffer is: 11110000, then the value is changed to: 00001111.

KEEP

Constant

public static const KEEP:String = "keep"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Keep the current stencil buffer value.

SET

Constant

public static const SET:String = "set"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Replace the stencil buffer value with the reference value.

ZERO

Constant

public static const ZERO:String = "zero"

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 11, AIR 3

Set the stencil buffer value to 0.

Context3DStencilAction - AS3

Classes x

DECREMENT_SATURATE

DECREMENT_WRAP

INCREMENT_SATURATE

INCREMENT_WRAP

INVERT

KEEP

SET

ZERO

flash.display3D Context3DStencilAction - AS3		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples