ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.display3D 

Context3DStencilAction  - AS3

Packageflash.display3D
Classpublic final class Context3DStencilAction
InheritanceContext3DStencilAction Inheritance 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



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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.