RasterFrame_GetPixelSize¶
Return the pixel size of a raster frame.
RasterFrame_GetPixelSize(imgDocRef{; frameIdx{; oriented}}) ➔ pixelSize
imgDocRef | Text | The raster document reference. |
frameIdx | Longint | The index of the raster frame. |
oriented | Boolean | Return the pixel size in the oriented image coordinate space. |
pixelSize | Object | The image frame’s pixel size. |
Return the pixel size of the raster frame specified by imgDocRef
and frameIdx
.
Parameter imgDocRef
is the raster document reference. If imgDocRef
refers
to a PDF document, an undefined 4D object is returned.
Parameter frameIdx
is the index of the image frame. Passing 0
or omitting this
parameter is the same as passing 1.
The optional oriented
parameter specified whether to return the frame’s pixel size
in the oriented or raw image coordinate space. The default value is True
.
The raster frame’s pixel size is returned in pixelSize
as a SizeObj
object.