ImagePixelFormat enumeration

ImagePixelFormat enumeration

Specifies the pixel format for the generated images of document pages.

Members

NameDescription
Format16BppRgb55516 bits per pixel, RGB.
Format16BppRgb56516 bits per pixel, RGB.
Format16BppArgb155516 bits per pixel, ARGB.
Format24BppRgb24 bits per pixel, RGB.
Format32BppRgb32 bits per pixel, RGB.
Format32BppArgb32 bits per pixel, ARGB.
Format32BppPArgb32 bits per pixel, ARGB, premultiplied alpha.
Format48BppRgb48 bits per pixel, RGB.
Format64BppArgb64 bits per pixel, ARGB.
Format64BppPArgb64 bits per pixel, ARGB, premultiplied alpha.
Format1bppIndexed1 bit per pixel, Indexed.

Examples

Shows how to select a bit-per-pixel rate with which to render a document to an image.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

builder.paragraphFormat.style = doc.styles.at("Heading 1");
builder.writeln("Hello world!");
builder.insertImage(base.imageDir + "Logo.jpg");

// When we save the document as an image, we can pass a SaveOptions object to
// select a pixel format for the image that the saving operation will generate.
// Various bit per pixel rates will affect the quality and file size of the generated image.
let imageSaveOptions = new aw.Saving.ImageSaveOptions(aw.SaveFormat.Png);
imageSaveOptions.pixelFormat = imagePixelFormat;

// We can clone ImageSaveOptions instances.
expect(imageSaveOptions.clone()).not.toBe(imageSaveOptions);
expect(imageSaveOptions.clone()).toEqual(imageSaveOptions);

doc.save(base.artifactsDir + "ImageSaveOptions.pixelFormat.png", imageSaveOptions);

See Also