iDRS™ SDK 16
Loading...
Searching...
No Matches
CImageLoadOptions_interface.h File Reference

Interface for CImageLoadOptions wrapper. More...

Go to the source code of this file.

Functions

CImageLoadOptions CImageLoadOptions_Create (enum ImageFormat const evImageFormat, idrs_exception *pargException)
 Creates a new instance of CImageLoadOptions and initializes it with the supplied image format.
 
enum ImageFormat CImageLoadOptions_GetImageFormat (const CImageLoadOptions argCImageLoadOptions, idrs_exception *pargException)
 Get the format where the loading options will apply.
 
void CImageLoadOptions_Destroy (CImageLoadOptions argCImageLoadOptions, idrs_exception *pargException)
 Destroys a CImageLoadOptions handle.
 

Detailed Description

Interface for CImageLoadOptions wrapper.

Function Documentation

◆ CImageLoadOptions_Create()

CImageLoadOptions CImageLoadOptions_Create ( enum ImageFormat const  evImageFormat,
idrs_exception *  pargException 
)

Creates a new instance of CImageLoadOptions and initializes it with the supplied image format.

Parameters
evImageFormatThe image format
pargExceptionPointer to exception structure that will be filled if an exception occurs
Returns
The newly created CImageLoadOptions object

◆ CImageLoadOptions_Destroy()

void CImageLoadOptions_Destroy ( CImageLoadOptions  argCImageLoadOptions,
idrs_exception *  pargException 
)

Destroys a CImageLoadOptions handle.

Parameters
argCImageLoadOptionsCImageLoadOptions handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CImageLoadOptions_GetImageFormat()

enum ImageFormat CImageLoadOptions_GetImageFormat ( const CImageLoadOptions  argCImageLoadOptions,
idrs_exception *  pargException 
)

Get the format where the loading options will apply.

Returns
The format
Parameters
argCImageLoadOptionsCImageLoadOptions handle
pargExceptionPointer to exception structure that will be filled if an exception occurs