.. _group__a3d__pdf__image__module:

############
Image Module
############

Add Images in the page.

This module describes the functions and structures that allow you to add images in the page. These images can only be added on a page, and cannot be retrieved from an existing page.

An image can be used as a static image to be inserted on a page at a specific position. Use :c:func:`~A3DPDFPageInsertImage2`\ for positionning such an image on a page. Also, an image can be stored as an icon in the document, and then be used for interactivity.

**Parameters**


   **pDoc**\ : The Document object to work with.

   **pcFileName**\ : File name of the image file.

   **eFormat**\ : Format of the image. If kA3DPDFImageFormatUnknown, the format is deducted from file extension.

   **ppImage**\ : The Image object created.


**Returns**


   A3D_SUCCESS in case of success or an error code


.. rst-class:: kind-group kind-enumeration

.. rubric:: Enumerations
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:enum:`~A3DPDFEImageFormat`

.. rst-class:: kind-group kind-function

.. rubric:: Functions
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:func:`~A3DPDFImageCreateFromFile`
* :c:func:`~A3DPDFImageCreateFromStream`
* :c:func:`~A3DPDFPageInsertImage2`

.. toctree::
   :maxdepth: 1
   :hidden:

   ../enums/A3DPDFEImageFormat
   ../functions/A3DPDFImageCreateFromFile
   ../functions/A3DPDFImageCreateFromStream
   ../functions/A3DPDFPageInsertImage2


