.. default-domain:: c
.. highlight:: c


Camera
======


.. type:: krpc_SpaceCenter_Camera_t

   Controls the game's camera.
   Obtained by calling :func:`krpc_SpaceCenter_Camera`.

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_Mode(krpc_connection_t connection, krpc_SpaceCenter_CameraMode_t * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_Mode(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, krpc_SpaceCenter_CameraMode_t value)

      The current mode of the camera.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_NextCamera(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance)

      Switch to the next available camera.
      In flight, this moves to the next flight camera mode. In IVA, it moves the
      view to the next crew member in the active vessel.


      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_PreviousCamera(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance)

      Switch to the previous available camera.
      In flight, this moves to the previous flight camera mode. In IVA, it moves
      the view to the previous crew member in the active vessel.


      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_Pitch(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_Pitch(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, float value)

      The pitch of the camera, in degrees.
      A value between :func:`krpc_SpaceCenter_Camera_MinPitch` and :func:`krpc_SpaceCenter_Camera_MaxPitch`

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_Heading(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_Heading(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, float value)

      The heading of the camera, in degrees.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_Distance(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_Distance(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, float value)

      The distance from the camera to the subject, in meters.
      A value between :func:`krpc_SpaceCenter_Camera_MinDistance` and :func:`krpc_SpaceCenter_Camera_MaxDistance`.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_FoV(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_FoV(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, float value)

      The Field of View of the camera, in degrees.
      A value between :func:`krpc_SpaceCenter_Camera_MinFoV` and :func:`krpc_SpaceCenter_Camera_MaxFoV`.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_MinPitch(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      The minimum pitch of the camera.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_MaxPitch(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      The maximum pitch of the camera.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_MinDistance(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      Minimum distance from the camera to the subject, in meters.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_MaxDistance(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      Maximum distance from the camera to the subject, in meters.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_MinFoV(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      The minimum field of view the camera in degrees.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_MaxFoV(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      The maximum field of view the camera in degrees.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_DefaultDistance(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      Default distance from the camera to the subject, in meters.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_DefaultFoV(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Camera_t instance)

      The default field of view the camera in degrees.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_FocussedBody(krpc_connection_t connection, krpc_SpaceCenter_CelestialBody_t * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_FocussedBody(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, krpc_SpaceCenter_CelestialBody_t value)

      In map mode, the celestial body that the camera is focussed on.
      Returns ``nullptr`` if the camera is not focussed on a celestial body.
      Returns an error is the camera is not in map mode.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_FocussedVessel(krpc_connection_t connection, krpc_SpaceCenter_Vessel_t * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_FocussedVessel(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, krpc_SpaceCenter_Vessel_t value)

      In map mode, the vessel that the camera is focussed on.
      Returns ``nullptr`` if the camera is not focussed on a vessel.
      Returns an error is the camera is not in map mode.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_FocussedNode(krpc_connection_t connection, krpc_SpaceCenter_Node_t * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_FocussedNode(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, krpc_SpaceCenter_Node_t value)

      In map mode, the maneuver node that the camera is focussed on.
      Returns ``nullptr`` if the camera is not focussed on a maneuver node.
      Returns an error is the camera is not in map mode.

      :Game Scenes: Flight

   .. function:: krpc_error_t krpc_SpaceCenter_Camera_FocussedCrewMember(krpc_connection_t connection, krpc_SpaceCenter_CrewMember_t * returnValue, krpc_SpaceCenter_Camera_t instance)
   .. function:: krpc_error_t krpc_SpaceCenter_Camera_set_FocussedCrewMember(krpc_connection_t connection, krpc_SpaceCenter_Camera_t instance, krpc_SpaceCenter_CrewMember_t value)

      In IVA mode, the crew member whose view the camera is showing.
      Returns ``nullptr`` if no crew member is in view.
      Returns an error if the camera is not in IVA mode.
      Setting this moves the view to the given crew member, switching the camera to
      IVA mode if it is not already. The crew member must be in the active vessel,
      and in a part whose interior the game has placed them in.

      :Game Scenes: Flight



.. type:: krpc_SpaceCenter_CameraMode_t

   See :func:`krpc_SpaceCenter_Camera_Mode`.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_AUTOMATIC

      The camera is showing the active vessel, in "auto" mode.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_FREE

      The camera is showing the active vessel, in "free" mode.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_CHASE

      The camera is showing the active vessel, in "chase" mode.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_LOCKED

      The camera is showing the active vessel, in "locked" mode.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_ORBITAL

      The camera is showing the active vessel, in "orbital" mode.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_IVA

      The Intra-Vehicular Activity view is being shown.


   .. macro:: KRPC_SPACECENTER_CAMERAMODE_MAP

      The map view is being shown.