.. index:: 
  !Image.flipTo Method
  
.. _id3_face_image_flip_to_class_method:

===============================================================================
Image.flipTo Method
===============================================================================

Module: :ref:`Image<id3_face_image_class>`

Definition
----------

Flips the image.


.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        flip_to(self, flip_horizontally: bool, flip_vertically: bool, dst_image: Image) -> None

      **Parameters**

        .. line-block::

          ``flip_horizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flip_vertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dst_image`` :ref:`Image<id3_face_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        void flipTo(bool flipHorizontally, bool flipVertically, Image dstImage)

      **Parameters**

        .. line-block::

          ``flipHorizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstImage`` :ref:`Image<id3_face_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public void FlipTo(bool flipHorizontally, bool flipVertically, Image dstImage)

      **Parameters**

        .. line-block::

          ``flipHorizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstImage`` :ref:`Image<id3_face_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public void flipTo(boolean flipHorizontally, boolean flipVertically, Image dstImage) throws FaceException

      **Parameters**

        .. line-block::

          ``flipHorizontally`` boolean
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` boolean
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstImage`` :ref:`Image<id3_face_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public func flipTo(flipHorizontally: Bool, flipVertically: Bool, dstImage: Image) throws

      **Parameters**

        .. line-block::

          ``flipHorizontally`` Bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` Bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``dstImage`` :ref:`Image<id3_face_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

        int id3FaceImage_FlipTo (
            ID3_FACE_IMAGE hImage, 
            bool flipHorizontally, 
            bool flipVertically, 
            ID3_FACE_IMAGE hDstImage)

      **Parameters**

        .. line-block::

          ``hImage`` :ref:`ID3_FACE_IMAGE<id3_face_image_class>`
          :guilabel:`in` Handle to the Image object.

          ``flipHorizontally`` bool
          :guilabel:`in` Value indicating whether the image should be flipped horizontally.

          ``flipVertically`` bool
          :guilabel:`in` Value indicating whether the image should be flipped vertically.

          ``hDstImage`` :ref:`ID3_FACE_IMAGE<id3_face_image_class>`
          :guilabel:`in` The destination Image object that receives the flipped image.


      **Returns**

        .. line-block::

          ``int``
          An error code.
          See :ref:`id3FaceError<id3_face_face_error_enum>` file for the list of possible error codes.


