Skip to content

class ImageSpec

  • namespace: luatex.img

Must be a table, and that table must contain a filename key.

Reference:

😱 Types incomplete or incorrect? 🙏 Please contribute!


fields


ImageSpec.attr


ImageSpec.attr : string?

the image attributes for LuaTeX

ImageSpec.bbox


ImageSpec.bbox : table?

table with 4 boundingbox dimensions llx, lly, urx and ury overruling the pagebox entry

ImageSpec.colordepth


ImageSpec.colordepth : number?

the number of bits used by the color space

ImageSpec.colorspace


ImageSpec.colorspace : number?

the color space object number

ImageSpec.depth


ImageSpec.depth : number?

the image depth for LuaTeX

ImageSpec.filename


ImageSpec.filename : string

the image file name

ImageSpec.filepath


ImageSpec.filepath : string?

the full (expanded) file name of the image

ImageSpec.height


ImageSpec.height : number?

the image height for LuaTeX

ImageSpec.imagetype


ImageSpec.imagetype : string?

one of pdf, png, jpg, jp2 or jbig2

ImageSpec.index


ImageSpec.index : number?

the PDF image name suffix

ImageSpec.objnum


ImageSpec.objnum : number?

the PDF image object number

ImageSpec.page


ImageSpec.page : number?

the identifier for the requested image page

ImageSpec.pagebox


ImageSpec.pagebox : string?

the requested bounding box, one of none, media, crop, bleed, trim, art

ImageSpec.pages


ImageSpec.pages : number?

the total number of available pages

ImageSpec.rotation


ImageSpec.rotation : number?

the image rotation from included PDF file, in multiples of 90 deg.

ImageSpec.stream


ImageSpec.stream : string?

the raw stream data for an /Xobject /Form object

ImageSpec.transform


ImageSpec.transform : number?

the image transform, integer number 0..7

ImageSpec.orientation


ImageSpec.orientation : number?

the (jpeg) image orientation, integer number 1..8 (0 for unset)

ImageSpec.width


ImageSpec.width : number?

the image width for LuaTeX

ImageSpec.xres


ImageSpec.xres : number?

the horizontal natural image resolution (in \DPI)

ImageSpec.xsize


ImageSpec.xsize : number?

the natural image width

ImageSpec.yres


ImageSpec.yres : number?

the vertical natural image resolution (in \DPI)

ImageSpec.ysize


ImageSpec.ysize : number?

the natural image height

ImageSpec.visiblefilename


ImageSpec.visiblefilename : string?

when set, this name will find its way in the PDF file as PTEX specification; when an empty string is assigned nothing is written to file; otherwise the natural filename is taken

ImageSpec.userpassword


ImageSpec.userpassword : string?

the userpassword needed for opening a PDF file

ImageSpec.ownerpassword


ImageSpec.ownerpassword : string?

the ownerpassword needed for opening a PDF file

ImageSpec.keepopen


ImageSpec.keepopen : boolean?

keep the PDF file open

ImageSpec.nobbox


ImageSpec.nobbox : boolean?

don't add a boundingbox specification for streams

ImageSpec.nolength


ImageSpec.nolength : boolean?

don't add length key nor compress for streams

ImageSpec.nosize


ImageSpec.nosize : boolean?

don't add size fields for streams