
#######################
A3DGraphAmbientLightGet
#######################

.. c:function:: A3DStatus A3DGraphAmbientLightGet(const A3DGraphAmbientLight *pLight, A3DGraphAmbientLightData *pData)

   .. rst-class:: sig-pretty-signature
   
      | :c:enum:`~A3DStatus` A3DGraphAmbientLightGet(*const* :c:type:`~A3DGraphAmbientLight`\ \* **pLight**\ , :c:struct:`~A3DGraphAmbientLightData`\ \* **pData**\ )
   
   Fetches data from an ambient light source entity given its handle.
   
   
      2.0
   
   
   **Return Values**
   
   
      **A3D_SUCCESS**\ : in case of success.
   
      **A3D_INITIALIZE_NOT_CALLED**\ : if the library is not initialized
   
      **A3D_INVALID_DATA_STRUCT_NULL**\ : if ``pData`` is null.
   
      **A3D_INVALID_DATA_STRUCT_SIZE**\ : if ``pData`` is incorrectly initialized
   
   
   .. code-block:: c
   
      // Retrieves the light data at index 3:
      A3DGraphAmbientLightData light = A3D_MAKE_DATA(A3DGraphAmbientLightData);
      A3DStatus result = A3DGraphAmbientLightGet(3, &light);
      assert(result == A3D_SUCCESS);
   
   
   ..
   
      :c:struct:`~A3DGraphAmbientLightData`
   
   
   
      :c:func:`~A3DGraphAmbientLightCreate`
   
   
   
      :c:struct:`~A3DGraphDirectionalLightData`
   
   
   
      :c:struct:`~A3DGraphPointLightData`
   
   
   
      :c:struct:`~A3DGraphSpotLightData`
   
   
   
      :c:struct:`~A3DGraphSceneDisplayParametersData`
   
   
   **Parameters**
   
   
      **pLight**\ : A handle to the light to fetch data from.
   
      **pData**\ : The ``A3DGraphAmbientLightData`` to fill in.
   
   
   **Returns**
   
   
      ``A3D_SUCCESS`` or an error code in case of failure.
   
   




