Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DocumentImage.pixelDepth Property

Module: DocumentImage

Type: int

## Definition

Pixel depth.

Python

    pixel_depth: int

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Dart

    int get pixelDepth => getPixelDepth();

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C#

    public int pixelDepth
    {
        get => GetpixelDepth();
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Java

    public int getPixelDepth() throws DocumentException

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Swift

    public var pixelDepth: Int
        get {
            return Int(try! getPixelDepth())
        }
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C

    int id3DocumentImage_GetPixelDepth (ID3_DOCUMENT_IMAGE hDocumentImage, int * pixelDepth)

Returns

> `int`
> An error code.
> See id3DocumentError file for the list of possible error codes.