DocumentImage.correctGamma Method

Module: DocumentImage

Definition

Applies a gamma correction to the image.

correct_gamma(self, contrast: int, brightness: int, gamma: float) -> None

Parameters

contrast int
in Contrast coefficient, from -255 to 255, to be applied to the image.

brightness int
in Brightness coefficient, from -255 to 255, to be applid to the image.

gamma float
in Gamma coefficient, from 0.25 to 2.50, to be applied to the image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
void correctGamma(int contrast, int brightness, double gamma)

Parameters

contrast int
in Contrast coefficient, from -255 to 255, to be applied to the image.

brightness int
in Brightness coefficient, from -255 to 255, to be applid to the image.

gamma double
in Gamma coefficient, from 0.25 to 2.50, to be applied to the image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void CorrectGamma(int contrast, int brightness, float gamma)

Parameters

contrast int
in Contrast coefficient, from -255 to 255, to be applied to the image.

brightness int
in Brightness coefficient, from -255 to 255, to be applid to the image.

gamma float
in Gamma coefficient, from 0.25 to 2.50, to be applied to the image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void correctGamma(int contrast, int brightness, float gamma) throws DocumentException

Parameters

contrast int
in Contrast coefficient, from -255 to 255, to be applied to the image.

brightness int
in Brightness coefficient, from -255 to 255, to be applid to the image.

gamma float
in Gamma coefficient, from 0.25 to 2.50, to be applied to the image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public func correctGamma(contrast: Int32, brightness: Int32, gamma: Float) throws

Parameters

contrast Int32
in Contrast coefficient, from -255 to 255, to be applied to the image.

brightness Int32
in Brightness coefficient, from -255 to 255, to be applid to the image.

gamma Float
in Gamma coefficient, from 0.25 to 2.50, to be applied to the image.

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentImage_CorrectGamma (
    ID3_DOCUMENT_IMAGE hDocumentImage,
    int contrast,
    int brightness,
    float gamma)

Parameters

hDocumentImage ID3_DOCUMENT_IMAGE
in Handle to the DocumentImage object.

contrast int
in Contrast coefficient, from -255 to 255, to be applied to the image.

brightness int
in Brightness coefficient, from -255 to 255, to be applid to the image.

gamma float
in Gamma coefficient, from 0.25 to 2.50, to be applied to the image.

Returns

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