QPix Command Reference
![]() |
![]() ![]() |
QPx_GetImporterFrameIndex(importerRef; frameIndex):error | |||
![]() |
importerRef | Longint | Graphics importer reference |
![]() |
frameIndex | Longint | Frame index |
![]() |
error | Longint | Error result |
Returns the current frame index of multi-frame images.
When working with multi-frame images all graphic importer commands apply to the "current frame". The current frame is identified by its index. The frame index ranges from 1 to the total number of frames in the image. The default frame index is 1.
The graphics importer instance is specified by importerRef. If importerRef is not a reference to a valid graphics importer instance, error qpx_paramErr is returned.
Parameter frameIndex receives the current frame index.
Note: A frame index value of zero (0) is usually equivalent to one (1), unless some importers treat the zero value in a special way.
Related commands
QPx_SetImporterFrameIndex | Changes the current frame in a multi-image container |
QPx_CountImporterFrames | Returns the number of images in a multi-image container |