pdf-core/io.github.limuyang2.pdf.core/PdfBitmap

PdfBitmap

interface PdfBitmap : AutoCloseable

A rendered page image owned by the caller.

The buffer uses PdfPixelFormat.Bgra8888 on the current backends. Closing releases the pixel buffer; all other properties keep working.

Properties

abstract val format: PdfPixelFormat

Pixel layout of the buffer.

abstract val height: Int

Bitmap height in pixels.

abstract val isClosed: Boolean

Whether close has been called.

abstract val stride: Int

Byte distance between the start of two adjacent rows. Rows are not guaranteed to be tightly packed, so always use stride when indexing the buffer.

abstract val width: Int

Bitmap width in pixels.

Functions

abstract override fun close()

abstract fun copyPixels(): ByteArray

Returns a copy of the full pixel buffer, including per-row padding.

abstract fun copyPixels(destination: ByteArray, destinationOffset: Int = 0)

Copies the full pixel buffer into destination starting at destinationOffset. The destination must have enough remaining capacity for the whole buffer.