Macros
#define	VPI_MAKE_COLOR_SPEC_ABBREV(cspace, encoding, xferFunc, range, locHoriz, locVert)
	Creates a user-defined color spec constant using abbreviated parameters. More...

#define	VPI_MAKE_COLOR_SPEC(cspace, encoding, xferFunc, range, locHoriz, locVert)
	Creates a user-defined color spec constant. More...

Enumerations
enum	VPIColorModel
	Defines color models. More...

enum	VPIColorSpace
	Defines the color primaries and the white point of a VPIColorSpec. More...

enum	VPIWhitePoint
	Defines the white point associated with a VPIColorSpace. More...

enum	VPIYCbCrEncoding
	Defines the YCbCr encoding used in a particular VPIColorSpec. More...

enum	VPIColorTransferFunction
	Defines the color transfer function in a particular VPIColorSpec. More...

enum	VPIColorRange
	Defines the color range of a particular VPIColorSpec. More...

enum	VPIChromaLocation
	Chroma sampling location. More...

enum	VPIColorSpec
	Color spec definitions. More...

enum	VPIRawPattern
	Defines Bayer patterns used by RAW color model. More...

enum	VPIChromaSubsampling
	Defines how chroma-subsampling is done. More...

Functions
VPIColorSpec	vpiMakeColorSpec (VPIColorSpace cspace, VPIYCbCrEncoding encoding, VPIColorTransferFunction xferFunc, VPIColorRange range, VPIChromaLocation locHoriz, VPIChromaLocation locVert)
	Creates a user-defined VPIColorSpec. More...

VPIChromaSubsampling	vpiMakeChromaSubsampling (int samplesHoriz, int samplesVert)
	Creates a VPIChromaSubsampling given the horizontal and vertical sampling. More...

int	vpiChromaSubsamplingGetSamplesHoriz (VPIChromaSubsampling css)
	Get the number of chroma samples for each group of 4 horizontal luma samples. More...

int	vpiChromaSubsamplingGetSamplesVert (VPIChromaSubsampling css)
	Get the number of chroma samples for each group of 4 vertical luma samples. More...

VPIChromaLocation	vpiColorSpecGetChromaLocHoriz (VPIColorSpec cspec)
	Get the chroma horizontal sampling location of a given color spec. More...

VPIChromaLocation	vpiColorSpecGetChromaLocVert (VPIColorSpec cspec)
	Get the chroma vertical sample location of a given color spec. More...

VPIColorSpec	vpiColorSpecSetChromaLoc (VPIColorSpec cspec, VPIChromaLocation locHoriz, VPIChromaLocation locVert)
	Set the chroma sample location of a given color spec. More...

VPIColorSpace	vpiColorSpecGetSpace (VPIColorSpec cspec)
	Get the color_space of a given color spec. More...

VPIColorSpec	vpiColorSpecSetSpace (VPIColorSpec cspec, VPIColorSpace cspace)
	Set the color_space of a given color spec. More...

VPIYCbCrEncoding	vpiColorSpecGetYCbCrEncoding (VPIColorSpec cspec)
	Get the R'G'B' <-> Y'CbCr encoding scheme of a given color spec. More...

VPIColorSpec	vpiColorSpecSetYCbCrEncoding (VPIColorSpec cspec, VPIYCbCrEncoding encoding)
	Set the R'G'B' <-> Y'CbCr encoding scheme of a given color spec. More...

VPIColorTransferFunction	vpiColorSpecGetTransferFunction (VPIColorSpec cspec)
	Get the color transfer function of a given color spec. More...

VPIColorSpec	vpiColorSpecSetTransferFunction (VPIColorSpec cspec, VPIColorTransferFunction xferFunc)
	Set the color transfer function of a given color spec. More...

VPIColorRange	vpiColorSpecGetRange (VPIColorSpec cspec)
	Get the color quantization range of a given color spec. More...

VPIColorSpec	vpiColorSpecSetRange (VPIColorSpec cspec, VPIColorRange range)
	Set the color quantization range of a given color spec. More...

const char *	vpiColorSpecGetName (VPIColorSpec cspec)
	Returns a string representation of the color spec. More...

Detailed Description

Macro Definition Documentation

◆ VPI_MAKE_COLOR_SPEC_ABBREV

#define VPI_MAKE_COLOR_SPEC_ABBREV	(	cspace,
		encoding,
		xferFunc,
		range,
		locHoriz,
		locVert
	)

#include <vpi/ColorSpec.h>

Creates a user-defined color spec constant using abbreviated parameters.

Example:

VPIColorSpec cspec = VPI_MAKE_COLOR_SPEC_ABBREV(SPACE_BT709, ENC_sRGB, XFER_sYCC, RANGE_FULL, LOC_ODD, LOC_EVEN);

VPIColorSpec

Color spec definitions.

Definition: ColorSpec.h:162

VPI_MAKE_COLOR_SPEC_ABBREV

#define VPI_MAKE_COLOR_SPEC_ABBREV(cspace, encoding, xferFunc, range, locHoriz, locVert)

Creates a user-defined color spec constant using abbreviated parameters.

Definition: ColorSpec.h:256

Parameters

[in]	cspace	Color Space.
[in]	encoding	R'G'B' <-> Y'CbCr encoding.
[in]	xferFunc	Color transfer function.
[in]	range	Color quantization range.
[in]	locHoriz	Horizontal chroma location.
[in]	locVert	Vertical chroma location.

Returns: The user-defined VPIColorSpec constant.

Definition at line 256 of file ColorSpec.h.

◆ VPI_MAKE_COLOR_SPEC

#define VPI_MAKE_COLOR_SPEC	(	cspace,
		encoding,
		xferFunc,
		range,
		locHoriz,
		locVert
	)

#include <vpi/ColorSpec.h>

Creates a user-defined color spec constant.

Example:

VPIColorSpec cspec = VPI_MAKE_COLOR_SPEC_ABBREV(VPI_COLOR_SPACE_BT709, VPI_YCbCr_ENC_sRGB, VPI_COLOR_XFER_sYCC,

VPI_COLOR_RANGE_FULL, VPI_CHROMA_LOC_ODD, VPI_CHROMA_LOC_EVEN);

VPI_COLOR_RANGE_FULL

@ VPI_COLOR_RANGE_FULL

Values cover the full underlying type range.

Definition: ColorSpec.h:131

VPI_COLOR_XFER_sYCC

@ VPI_COLOR_XFER_sYCC

Color transfer function specified by sYCC standard.

Definition: ColorSpec.h:121

VPI_COLOR_SPACE_BT709

@ VPI_COLOR_SPACE_BT709

Color primaries from ITU-R BT.709 standard, D65 white point.

Definition: ColorSpec.h:90

VPI_CHROMA_LOC_ODD

@ VPI_CHROMA_LOC_ODD

Sample the chroma with odd coordinate.

Definition: ColorSpec.h:140

VPI_CHROMA_LOC_EVEN

@ VPI_CHROMA_LOC_EVEN

Sample the chroma with even coordinate.

Definition: ColorSpec.h:138

Parameters

[in]	cspace	Color Space.
[in]	encoding	R'G'B' <-> Y'CbCr encoding.
[in]	xferFunc	Color transfer function.
[in]	range	Color quantization range.
[in]	locHoriz	Horizontal chroma location.
[in]	locVert	Vertical chroma location.

Returns: The user-defined VPIColorSpec constant.

Definition at line 279 of file ColorSpec.h.

Enumeration Type Documentation

◆ VPIColorModel

enum VPIColorModel

#include <vpi/ColorSpec.h>

Defines color models.

A color model gives meaning to each channel of an image format. They are specified in a canonical XYZW ordering that can then be swizzled to the desired ordering.

Enumerator
VPI_COLOR_MODEL_UNDEFINED	Color model is undefined.
VPI_COLOR_MODEL_YCbCr	Luma + chroma (blue-luma, red-luma).
VPI_COLOR_MODEL_RGB	red, green, blue components.
VPI_COLOR_MODEL_RAW	RAW color model, used for Bayer image formats.
VPI_COLOR_MODEL_XYZ	CIE XYZ tristimulus color spec.

Definition at line 76 of file ColorSpec.h.

◆ VPIColorSpace

enum VPIColorSpace

#include <vpi/ColorSpec.h>

Defines the color primaries and the white point of a VPIColorSpec.

Enumerator
VPI_COLOR_SPACE_SENSOR	Color space from the sensor used to capture the image.
VPI_COLOR_SPACE_BT601	Color primaries from ITU-R BT.601/625 lines standard, also known as EBU 3213-E.
VPI_COLOR_SPACE_BT709	Color primaries from ITU-R BT.709 standard, D65 white point.
VPI_COLOR_SPACE_BT2020	Color primaries from ITU-R BT.2020 standard, D65 white point.
VPI_COLOR_SPACE_DCIP3	Color primaries from DCI-P3 standard, D65 white point.
VPI_COLOR_SPACE_UNDEFINED	Color space not defined.

Definition at line 86 of file ColorSpec.h.

◆ VPIWhitePoint

enum VPIWhitePoint

#include <vpi/ColorSpec.h>

Defines the white point associated with a VPIColorSpace.

Enumerator
VPI_WHITE_POINT_D65	D65 white point, K = 6504.
VPI_WHITE_POINT_UNDEFINED	White point not defined.

Definition at line 98 of file ColorSpec.h.

◆ VPIYCbCrEncoding

enum VPIYCbCrEncoding

#include <vpi/ColorSpec.h>

Defines the YCbCr encoding used in a particular VPIColorSpec.

Enumerator
VPI_YCbCr_ENC_UNDEFINED	Encoding not defined. Usually used by non-YCbCr color specs.
VPI_YCbCr_ENC_BT601	Encoding specified by ITU-R BT.601 standard.
VPI_YCbCr_ENC_BT709	Encoding specified by ITU-R BT.709 standard.
VPI_YCbCr_ENC_BT2020	Encoding specified by ITU-R BT.2020 standard.
VPI_YCbCr_ENC_BT2020c	Encoding specified by ITU-R BT.2020 with constant luminance.
VPI_YCbCr_ENC_SMPTE240M	Encoding specified by SMPTE 240M standard.

Definition at line 106 of file ColorSpec.h.

◆ VPIColorTransferFunction

enum VPIColorTransferFunction

#include <vpi/ColorSpec.h>

Defines the color transfer function in a particular VPIColorSpec.

Enumerator
VPI_COLOR_XFER_LINEAR	Linear color transfer function.
VPI_COLOR_XFER_sRGB	Color transfer function specified by sRGB standard.
VPI_COLOR_XFER_sYCC	Color transfer function specified by sYCC standard.
VPI_COLOR_XFER_PQ	Perceptual quantizer color transfer function.
VPI_COLOR_XFER_BT709	Color transfer function specified by ITU-R BT.709 standard.
VPI_COLOR_XFER_BT2020	Color transfer function specified by ITU-R BT.2020 standard.
VPI_COLOR_XFER_SMPTE240M	Color transfer function specified by SMPTE 240M standard.

Definition at line 117 of file ColorSpec.h.

◆ VPIColorRange

enum VPIColorRange

#include <vpi/ColorSpec.h>

Defines the color range of a particular VPIColorSpec.

Enumerator
VPI_COLOR_RANGE_FULL	Values cover the full underlying type range.
VPI_COLOR_RANGE_LIMITED	Values cover a limited range of the underlying type.

Definition at line 129 of file ColorSpec.h.

◆ VPIChromaLocation

enum VPIChromaLocation

#include <vpi/ColorSpec.h>

Chroma sampling location.

Enumerator
VPI_CHROMA_LOC_EVEN	Sample the chroma with even coordinate.
VPI_CHROMA_LOC_CENTER	Sample the chroma exactly between the even and odd coordinate.
VPI_CHROMA_LOC_ODD	Sample the chroma with odd coordinate.
VPI_CHROMA_LOC_BOTH	Sample chroma from even and odd coordinates. This is used when no sub-sampling is taking place.

Definition at line 136 of file ColorSpec.h.

◆ VPIColorSpec

enum VPIColorSpec

#include <vpi/ColorSpec.h>

Color spec definitions.

These color specs define how color information is to be interpreted. It is defined by several parameters:

These parameters together defines how the color representation maps to its corresponding absolute color in a chromacity diagram.

Enumerator
VPI_COLOR_SPEC_INVALID	Invalid color spec. This is to be used when no color spec is selected.
VPI_COLOR_SPEC_DEFAULT	Default color spec. Informs that the color spec is to be inferred.
VPI_COLOR_SPEC_UNDEFINED	No color spec defined. Used when color spec isn't relevant or is not defined. The color spec may be inferred from the context. If this isn't possible, the values for each color spec component defined below will be used.
VPI_COLOR_SPEC_BT601	Color spec defining ITU-R BT.601 standard, limited range, with BT.709 chrominancies and transfer function.
VPI_COLOR_SPEC_BT601_ER	Color spec defining ITU-R BT.601 standard, full range, with BT.709 chrominancies and transfer function.
VPI_COLOR_SPEC_BT709	Color spec defining ITU-R BT.709 standard, limited range.
VPI_COLOR_SPEC_BT709_ER	Color spec defining ITU-R BT.709 standard, full range.
VPI_COLOR_SPEC_BT709_LINEAR	Color spec defining ITU-R BT.709 standard, limited range and linear transfer function.
VPI_COLOR_SPEC_BT2020	Color spec defining ITU-R BT.2020 standard, limited range.
VPI_COLOR_SPEC_BT2020_ER	Color spec defining ITU-R BT.2020 standard, full range.
VPI_COLOR_SPEC_BT2020_LINEAR	Color spec defining ITU-R BT.2020 standard, limited range and linear transfer function.
VPI_COLOR_SPEC_BT2020_PQ	Color spec defining ITU-R BT.2020 standard, limited range and perceptual quantizer transfer function.
VPI_COLOR_SPEC_BT2020_PQ_ER	Color spec defining ITU-R BT.2020 standard, full range and perceptual quantizer transfer function.
VPI_COLOR_SPEC_BT2020c	Color spec defining ITU-R BT.2020 standard for constant luminance, limited range.
VPI_COLOR_SPEC_BT2020c_ER	Color spec defining ITU-R BT.2020 standard for constant luminance, full range.
VPI_COLOR_SPEC_MPEG2_BT601	Color spec defining MPEG2 standard using ITU-R BT.601 encoding.
VPI_COLOR_SPEC_MPEG2_BT709	Color spec defining MPEG2 standard using ITU-R BT.709 encoding.
VPI_COLOR_SPEC_MPEG2_SMPTE240M	Color spec defining MPEG2 standard using SMPTE 240M encoding.
VPI_COLOR_SPEC_sRGB	Color spec defining sRGB standard.
VPI_COLOR_SPEC_sYCC	Color spec defining sYCC standard.
VPI_COLOR_SPEC_SMPTE240M	Color spec defining SMPTE 240M standard, limited range.
VPI_COLOR_SPEC_DISPLAYP3	Color spec defining Display P3 standard, with sRGB color transfer function.
VPI_COLOR_SPEC_DISPLAYP3_LINEAR	Color spec defining Display P3 standard, with linear color transfer function.
VPI_COLOR_SPEC_SENSOR	Color spec used for images coming from an image sensor, right after demosaicing.

Definition at line 161 of file ColorSpec.h.

◆ VPIRawPattern

enum VPIRawPattern

#include <vpi/ColorSpec.h>

Defines Bayer patterns used by RAW color model.

R,G,B represent the color primaries red, green, blue. C represent a clear channel, it lets all light pass.

Enumerator
VPI_RAW_INVALID	Invalid raw pattern.
VPI_RAW_BAYER_RGGB	Bayer format with X channel mapped to samples as follows: span 1: R G R G R G R G span 2: G B G B G B G B (Y,Z,W are discarded)
VPI_RAW_BAYER_BGGR	Bayer format with X channel mapped to samples as follows: span 1: B G B G B G B G span 2: G R G R G R G R (Y,Z,W are discarded)
VPI_RAW_BAYER_GRBG	Bayer format with X channel mapped to samples as follows: span 1: G R G R G R G R span 2: B G B G B G B G (Y,Z,W are discarded)
VPI_RAW_BAYER_GBRG	Bayer format with X channel mapped to samples as follows: span 1: G B G B G B G B span 2: R G R G R G R G (Y,Z,W are discarded)
VPI_RAW_BAYER_RCCB	Bayer format with X channel mapped to samples as follows: span 1: R C R C R C R C span 2: C B C B C B C B (Y,Z,W are discarded)
VPI_RAW_BAYER_BCCR	Bayer format with X channel mapped to samples as follows: span 1: B C B C B C B C span 2: C R C R C R C R (Y,Z,W are discarded)
VPI_RAW_BAYER_CRBC	Bayer format with X channel mapped to samples as follows: span 1: C R C R C R C R span 2: B C B C B C B C (Y,Z,W are discarded)
VPI_RAW_BAYER_CBRC	Bayer format with X channel mapped to samples as follows: span 1: C B C B C B C B span 2: R C R C R C R C (Y,Z,W are discarded)
VPI_RAW_BAYER_RCCC	Bayer format with X channel mapped to samples as follows: span 1: R C R C R C R C span 2: C C C C C C C C (Y,Z,W are discarded)
VPI_RAW_BAYER_CRCC	Bayer format with X channel mapped to samples as follows: span 1: C R C R C R C R span 2: C C C C C C C C (Y,Z,W are discarded)
VPI_RAW_BAYER_CCRC	Bayer format with X channel mapped to samples as follows: span 1: C C C C C C C C span 2: R C R C R C R C (Y,Z,W are discarded)
VPI_RAW_BAYER_CCCR	Bayer format with X channel mapped to samples as follows: span 1: C C C C C C C C span 2: C R C R C R C R (Y,Z,W are discarded)
VPI_RAW_BAYER_CCCC	Bayer format with X channel mapped to samples as follows: span 1: C C C C C C C C span 2: C C C C C C C C (Y,Z,W are discarded)

Definition at line 302 of file ColorSpec.h.

◆ VPIChromaSubsampling

enum VPIChromaSubsampling

#include <vpi/ColorSpec.h>

Defines how chroma-subsampling is done.

This is only applicable to image formats whose color model is YUV. Other image formats must use VPI_CSS_NONE. Chroma subsampling is defined by 2 parameters:

Horizontal resolution relative to luma resolution.
Vertical resolution relative to luma resolution.

Enumerator
VPI_CSS_INVALID	Invalid chroma subsampling.
VPI_CSS_NONE	Used when no chroma subsampling takes place, specially for color specs without chroma components.
VPI_CSS_444	4:4:4 sub-sampling. Chroma has full horizontal and vertical resolution, meaning no chroma subsampling.
VPI_CSS_422	4:2:2 BT.601 sub-sampling. Chroma has half horizontal and full vertical resolutions.
VPI_CSS_422R	4:2:2R BT.601 sub-sampling. Chroma has full horizontal and half vertical resolutions.
VPI_CSS_411	4:1:1 sub-sampling. Chroma has 1/4 horizontal and full vertical resolutions.
VPI_CSS_411R	4:1:1 sub-sampling. Chroma has full horizontal and 1/4 vertical resolutions.
VPI_CSS_420	4:2:0 sub-sampling. Chroma has half horizontal and vertical resolutions.

Definition at line 399 of file ColorSpec.h.

Function Documentation

◆ vpiMakeColorSpec()

VPIColorSpec vpiMakeColorSpec	(	VPIColorSpace	cspace,
		VPIYCbCrEncoding	encoding,
		VPIColorTransferFunction	xferFunc,
		VPIColorRange	range,
		VPIChromaLocation	locHoriz,
		VPIChromaLocation	locVert
	)

#include <vpi/ColorSpec.h>

Creates a user-defined VPIColorSpec.

Parameters

[in]	cspace	Color space.
[in]	encoding	R'G'B' <-> Y'CbCr encoding.
[in]	xferFunc	Color transfer function.
[in]	range	Color quantization range.
[in]	locHoriz	Horizontal chroma location.
[in]	locVert	Vertical chroma location.

Returns: The user-defined VPIColorSpec.

◆ vpiMakeChromaSubsampling()

VPIChromaSubsampling vpiMakeChromaSubsampling	(	int	samplesHoriz,
		int	samplesVert
	)

#include <vpi/ColorSpec.h>

Creates a VPIChromaSubsampling given the horizontal and vertical sampling.

Parameters

[in]	samplesHoriz	Number of horizontal samples, 1, 2 or 4.
[in]	samplesVert	Number of vertical samples, 1, 2 or 4.

Returns: The chroma subsampling enumeration.

Return values

VPI_CSS_NONE Chroma subsampling isn't defined.

◆ vpiChromaSubsamplingGetSamplesHoriz()

int vpiChromaSubsamplingGetSamplesHoriz ( VPIChromaSubsampling css )

#include <vpi/ColorSpec.h>

Get the number of chroma samples for each group of 4 horizontal luma samples.

Parameters

[in]

css

Chroma subsampling to be queried.

css must be valid.

Returns: The number of chroma samples for each group of 4 horizontal luma samples.

Return values

0	`css` is invalid.

◆ vpiChromaSubsamplingGetSamplesVert()

int vpiChromaSubsamplingGetSamplesVert ( VPIChromaSubsampling css )

#include <vpi/ColorSpec.h>

Get the number of chroma samples for each group of 4 vertical luma samples.

Parameters

[in]

css

Chroma subsampling to be queried.

css must be valid.

Returns: The number of chroma samples for each group of 4 vertical luma samples.

Return values

0	`css` is invalid.

◆ vpiColorSpecGetChromaLocHoriz()

VPIChromaLocation vpiColorSpecGetChromaLocHoriz ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Get the chroma horizontal sampling location of a given color spec.

Parameters

[in]

cspec

Color spec to be queried.

Color spec must be valid.

Returns: Chroma sample location with respect to luma horizontal coordinate.

Return values

VPI_CHROMA_LOC_BOTH cspec is invalid.

◆ vpiColorSpecGetChromaLocVert()

VPIChromaLocation vpiColorSpecGetChromaLocVert ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Get the chroma vertical sample location of a given color spec.

Parameters

[in]

cspec

Color spec to be queried.

Color spec must be valid.

Returns: Chroma sample location with respect to luma vertical coordinate.

Return values

VPI_CHROMA_LOC_BOTH cspec is invalid.

◆ vpiColorSpecSetChromaLoc()

VPIColorSpec vpiColorSpecSetChromaLoc	(	VPIColorSpec	cspec,
		VPIChromaLocation	locHoriz,
		VPIChromaLocation	locVert
	)

#include <vpi/ColorSpec.h>

Set the chroma sample location of a given color spec.

Parameters

[in]	cspec	The color spec to be modified. `cspec` must be valid.
[in]	locHoriz	Horizontal chroma sampling location with respect to luma coordinate.
[in]	locVert	Vertical chroma sampling location with respect to luma coordinate.

Returns: The new color spec with the updated chroma location.

Return values

VPI_COLOR_SPEC_INVALID cspec is invalid.

◆ vpiColorSpecGetSpace()

VPIColorSpace vpiColorSpecGetSpace ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Get the color_space of a given color spec.

Parameters

[in]

cspec

Color spec to be queried.

cspec must be valid.

Returns: The color_space associated with the color spec.

Return values

VPI_COLOR_SPACE_UNDEFINED cspec is invalid.

◆ vpiColorSpecSetSpace()

VPIColorSpec vpiColorSpecSetSpace	(	VPIColorSpec	cspec,
		VPIColorSpace	cspace
	)

#include <vpi/ColorSpec.h>

Set the color_space of a given color spec.

Parameters

[in]	cspec	Color spec to be updated. `cspec` must be valid.
[in]	cspace	The new color_space.

Returns: The new color spec with the updated color_space.

Return values

VPI_COLOR_SPEC_INVALID	`cspec` is invalid.
VPI_COLOR_SPEC_INVALID	`cspace` is invalid.

◆ vpiColorSpecGetYCbCrEncoding()

VPIYCbCrEncoding vpiColorSpecGetYCbCrEncoding ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Get the R'G'B' <-> Y'CbCr encoding scheme of a given color spec.

Parameters

[in]

cspec

Color spec to be queried.

cspec must be valid.

Returns: The Y'CbCr encoding scheme associated with the color spec.

Return values

VPI_YCbCr_ENC_UNDEFINED cspec is invalid.

◆ vpiColorSpecSetYCbCrEncoding()

VPIColorSpec vpiColorSpecSetYCbCrEncoding	(	VPIColorSpec	cspec,
		VPIYCbCrEncoding	encoding
	)

#include <vpi/ColorSpec.h>

Set the R'G'B' <-> Y'CbCr encoding scheme of a given color spec.

Parameters

[in]	cspec	Color spec to be updated. `cspec` must be valid.
[in]	encoding	The new Y'CbCr encoding scheme.

Returns: The new color spec with the updated Y'CbCr encoding scheme.

Return values

VPI_COLOR_SPEC_INVALID cspec is invalid.

◆ vpiColorSpecGetTransferFunction()

VPIColorTransferFunction vpiColorSpecGetTransferFunction ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Get the color transfer function of a given color spec.

Parameters

[in]

cspec

Color spec to be queried.

cspec must be valid.

Returns: The color transfer function of a given color spec.

Return values

VPI_COLOR_XFER_LINEAR if cspec is invalid.

◆ vpiColorSpecSetTransferFunction()

VPIColorSpec vpiColorSpecSetTransferFunction	(	VPIColorSpec	cspec,
		VPIColorTransferFunction	xferFunc
	)

#include <vpi/ColorSpec.h>

Set the color transfer function of a given color spec.

Parameters

[in]	cspec	Color spec to be updated. `cspec` must be valid.
[in]	xferFunc	The new color transfer function.

Returns: The new color spec with the updated color transfer function.

Return values

VPI_COLOR_SPEC_INVALID cspec is invalid.

◆ vpiColorSpecGetRange()

VPIColorRange vpiColorSpecGetRange ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Get the color quantization range of a given color spec.

Parameters

[in]

cspec

Color spec to be queried.

cspec must be valid.

Returns: The color quantization range of a given color spec.

Return values

VPI_COLOR_RANGE_FULL cspec is invalid.

◆ vpiColorSpecSetRange()

VPIColorSpec vpiColorSpecSetRange	(	VPIColorSpec	cspec,
		VPIColorRange	range
	)

#include <vpi/ColorSpec.h>

Set the color quantization range of a given color spec.

Parameters

[in]	cspec	Color spec to be updated. `cspec` must be valid.
[in]	range	The new color quantization range.

Returns: The new color spec with the updated color quantization range.

Return values

VPI_COLOR_SPEC_INVALID cspec is invalid.

◆ vpiColorSpecGetName()

const char* vpiColorSpecGetName ( VPIColorSpec cspec )

#include <vpi/ColorSpec.h>

Returns a string representation of the color spec.

Parameters

[in] cspec Color spec whose name is to be returned.

Returns: The string representation of the color spec. Returned string is valid until next call of this function from the same calling thread. Returned pointer must not be freed.

VPI - Vision Programming Interface

4.0 Release

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ VPI_MAKE_COLOR_SPEC_ABBREV

◆ VPI_MAKE_COLOR_SPEC

Enumeration Type Documentation

◆ VPIColorModel

◆ VPIColorSpace

◆ VPIWhitePoint

◆ VPIYCbCrEncoding

◆ VPIColorTransferFunction

◆ VPIColorRange

◆ VPIChromaLocation

◆ VPIColorSpec

◆ VPIRawPattern

◆ VPIChromaSubsampling

Function Documentation

◆ vpiMakeColorSpec()

◆ vpiMakeChromaSubsampling()

◆ vpiChromaSubsamplingGetSamplesHoriz()

◆ vpiChromaSubsamplingGetSamplesVert()

◆ vpiColorSpecGetChromaLocHoriz()

◆ vpiColorSpecGetChromaLocVert()

◆ vpiColorSpecSetChromaLoc()

◆ vpiColorSpecGetSpace()

◆ vpiColorSpecSetSpace()

◆ vpiColorSpecGetYCbCrEncoding()

◆ vpiColorSpecSetYCbCrEncoding()

◆ vpiColorSpecGetTransferFunction()

◆ vpiColorSpecSetTransferFunction()

◆ vpiColorSpecGetRange()

◆ vpiColorSpecSetRange()

◆ vpiColorSpecGetName()