Image Module

Types

A3DPDFImageData

A3DPDFEImageFormat

Fields

kA3DPDFImageFormatUnknown

kA3DPDFImageFormatBmp

kA3DPDFImageFormatPng

kA3DPDFImageFormatJpg

kA3DPDFImageFormatBitmapRgbByte

kA3DPDFImageFormatBitmapRgbaByte

kA3DPDFImageFormatBitmapGreyByte

kA3DPDFImageFormatBitmapGreyaByte

kA3DPDFImageFormatEmf

kA3DPDFImageFormatUrl

kA3DPDFImageFormatGif

kA3DPDFImageFormatTif

kA3DPDFImageFormatPcx

kA3DPDFImageFormatTga

kA3DPDFImageFormatPpm

kA3DPDFImageFormatIlbm

kA3DPDFImageFormatCel

kA3DPDFImageFormatRgb

kA3DPDFImageFormatPsd

kA3DPDFImageFormatSoftimagepic

Functions

A3D_API_DEPRECATED

A3DStatus

A3DPDFImageCreateFromFile

A3DStatus

A3DPDFImageCreateFromStream

A3D_API_DEPRECATED

A3DStatus

A3DPDFPageInsertImage2

Detailed Description

group a3d_pdf_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 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.

Type Documentation

enum A3DPDFEImageFormat

The following image formats are available in HOOPS.

Remark

EMF is only supported on Windows.

Remark

Starting from version 2020, some of these formats are not supported anymore. These are Cel, ILBM, PSD, PCX and TIFF.

See also

A3DPDFImageData

See also

A3DPDFImageCreateFromStream

See also

A3DPDFImageCreateFromFile

See also

A3DPDFDocumentExportAsImage

See also

A3DPDFDocumentExportAsImage

Version

4.1

Values:

enumerator kA3DPDFImageFormatUnknown

Undefined format

enumerator kA3DPDFImageFormatBmp

BMP format

enumerator kA3DPDFImageFormatPng

PNG format

enumerator kA3DPDFImageFormatJpg

JPEG format

enumerator kA3DPDFImageFormatBitmapRgbByte

Bitmap RGB format

enumerator kA3DPDFImageFormatBitmapRgbaByte

Bitmap RGBA format

enumerator kA3DPDFImageFormatBitmapGreyByte

Bitmap grey format

enumerator kA3DPDFImageFormatBitmapGreyaByte

Bitmap greya format

enumerator kA3DPDFImageFormatEmf

EMF format, Windows only

enumerator kA3DPDFImageFormatUrl

URL format

enumerator kA3DPDFImageFormatGif

GIF format

enumerator kA3DPDFImageFormatTif

TIFF format, unsupported

enumerator kA3DPDFImageFormatPcx

PCX format, unsupported

enumerator kA3DPDFImageFormatTga

TGA format

enumerator kA3DPDFImageFormatPpm

PPM format

enumerator kA3DPDFImageFormatIlbm

ILBM format, unsupported

enumerator kA3DPDFImageFormatCel

Cel format, unsupported

enumerator kA3DPDFImageFormatRgb

RGB format

enumerator kA3DPDFImageFormatPsd

PSD format, unsupported

enumerator kA3DPDFImageFormatSoftimagepic

Softimagepic format

Function Documentation

Warning

doxygenfunction: Unable to resolve function “A3D_API_DEPRECATED” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expected identifier in nested name. [error at 60] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) ————————————————————^ If the function has a return type: Error in declarator If declarator-id with parameters-and-qualifiers: Invalid C++ declaration: Expected identifier in nested name. [error at 19] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) ——————-^ If parenthesis in noptr-declarator: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected ‘::’ in pointer to member (function). [error at 29] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) —————————–^ If declarator-id: Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 29] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) —————————–^

A3DStatus A3DPDFImageCreateFromFile(A3DPDFDocument *pDoc, const A3DUTF8Char *pcFileName, const A3DPDFEImageFormat eFormat, A3DPDFImage **ppImage)

Function to create an image object from a file.

The image object is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertImage2.

Version

10.2

Parameters:

  • pDoc – [inout] The Document object to work with.

  • pcFileName – [in] File name of the image file.

  • eFormat – [in] Format of the image. If kA3DPDFImageFormatUnknown, the format is deducted from file extension.

  • ppImage – [out] The Image object created.

Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPDFImageCreateFromStream(A3DPDFDocument *pDoc, const A3DUTF8Char *pcStream, const A3DInt32 iLengthStream, const A3DPDFEImageFormat eFormat, A3DPDFImage **ppImage)

Function to create an image object from a file.

The image object is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertImage2.

Version

10.2

Parameters:

  • pDoc – [inout] The Document object to work with.

  • pcStream – [in] The buffer.

  • iLengthStream – [in] The length of the buffer.

  • eFormat – [in] Format of the image. It is mandatory to be specified for a buffer.

  • ppImage – [out] The Image object created.

Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code

Warning

doxygenfunction: Unable to resolve function “A3D_API_DEPRECATED” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expected identifier in nested name. [error at 60] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) ————————————————————^ If the function has a return type: Error in declarator If declarator-id with parameters-and-qualifiers: Invalid C++ declaration: Expected identifier in nested name. [error at 19] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) ——————-^ If parenthesis in noptr-declarator: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected ‘::’ in pointer to member (function). [error at 29] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) —————————–^ If declarator-id: Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 29] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) —————————–^

A3DStatus A3DPDFPageInsertImage2(A3DPDFPage *pPage, A3DPDFImage *pImage, const A3DPDFRectData *pRectData)

Function to insert a static image in a page. With this, an image is positionned on a page but can not be used for interactivity.

Version

10.2

Parameters:

  • pPage – [inout] The Page object to work with.

  • pImage – [in] The Image object to insert on the page.

  • pRectData – [in] The rectangle to specify the position on the page.

Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code