Stage3D  - AS3

The Context3D object associated with this Stage3D instance.

This property is initially null. To create the Context3D instance for this Stage3D object, add an event listener for the context3DCreate event and then call the requestContext3D method. The listener is called once the Context3D object has been created.

Related API Elements

Specifies whether this Stage3D object is visible.

Use this property to temporarily hide a Stage3D object on the Stage. This property defaults to true.

The horizontal coordinate of the Stage3D display on the stage, in pixels.

This property defaults to zero.

The vertical coordinate of the Stage3D display on the stage, in pixels.

This property defaults to zero.

Request the creation of a Context3D object for this Stage3D instance.

Before calling this function, add an event listener for the context3DCreate event. If you do not, the runtime throws an exception.

Important note on device loss: GPU device loss occurs when the GPU hardware becomes unavailable to the application. The Context3D object is disposed when the GPU device is lost. GPU device loss can happen for various reasons, such as, when a mobile device runs out of battery power or a Windows device goes to a "lock screen." When the GPU becomes available again, the runtime creates a new Context3D instance and dispatches another context3DCreate event. Your application must reload all assets and reset the rendering context state whenever device loss occurs.

Design your application logic to handle the possibility of device loss and context regeneration. Do not remove the context3DCreate event listener. Do not perform actions in response to the event that should not be repeated in the application. For example, do not add anonymous functions to handle timer events because they would be duplicated after device loss. To test your application's handling of device loss, you can simulate device loss by calling the dispose() method of the Context3D object.

The following example illustrates how to request a Context3d rendering context:

        if( stage.stage3Ds.length > 0 )
        {
            var stage3D:Stage3D = stage.stage3Ds[0];    
            stage3D.addEventListener( Event.CONTEXT3D_CREATE, myContext3DHandler ); 
            stage3D.requestContext3D( ); 
        } 
        
        function myContext3DHandler ( event : Event ) : void 
        {
            var targetStage3D : Stage3D = event.target as Stage3D; 
            InitAll3DResources( targetStage3D.context3D );
            StartRendering( targetStage3D.context3D ); 
        }
        

Parameters

Related API Elements

Request the creation of a Context3D object for this Stage3D instance.

Before calling this function, add an event listener for the context3DCreate event. If you do not, the runtime throws an exception.

Important note on device loss: GPU device loss occurs when the GPU hardware becomes unavailable to the application. The Context3D object is disposed when the GPU device is lost. GPU device loss can happen for various reasons, such as, when a mobile device runs out of battery power or a Windows device goes to a "lock screen." When the GPU becomes available again, the runtime creates a new Context3D instance and dispatches another context3DCreate event. Your application must reload all assets and reset the rendering context state whenever device loss occurs.

Design your application logic to handle the possibility of device loss and context regeneration. Do not remove the context3DCreate event listener. Do not perform actions in response to the event that should not be repeated in the application. For example, do not add anonymous functions to handle timer events because they would be duplicated after device loss. To test your application's handling of device loss, you can simulate device loss by calling the dispose() method of the Context3D object.

The following example illustrates how to request a Context3d rendering context:

        if( stage.stage3Ds.length > 0 )
        {
          var stage3D:Stage3D = stage.stage3Ds[0];   
          stage3D.addEventListener( Event.CONTEXT3D_CREATE, myContext3DHandler );
          stage3D.requestContext3DMatchingProfiles(Vector.<string>([Context3DProfile.BASELINE, Context3DProfile.BASELINE_EXTENDED]));
        }
        
        function myContext3DHandler ( event : Event ) : void
        {
               var targetStage3D : Stage3D = event.target as Stage3D;
            if(targetStage3D.context3D.profile.localeCompare(Context3DProfile.BASELINE) == 0)
            {
                  InitAll3DResources( targetStage3D.context3D );          
            }
            StartRendering( targetStage3D.context3D );        
        

Parameters

Related API Elements

Dispatched when a rendering context is created.

Related API Elements

Dispatched when a request for a rendering context fails.

This event has the following properties:

Related API Elements