Module yuva_info
Expand description
Specifies the structure of planes for a YUV image with optional alpha. The actual planar data is not part of this structure and depending on usage is in external textures or pixmaps.
Enums§
- Plane
Config - Siting
- Subsampling
- UV subsampling is also specified in the enum value names using J:a:b notation (e.g. 4:2:0 is
1/2 horizontal and 1/2 vertical resolution for U and V). If alpha is present it is not sub-
sampled. Note that Subsampling values other than k444 are only valid with
PlaneConfigvalues that have U and V in different planes than Y (and A, if present), with the exception ofPlaneConfig::YUYVwhich represents packed 4:2:2 and is only valid withSubsampling::S422.
Functions§
- has_
alpha - Does the
PlaneConfighave alpha values? - num_
channels_ in_ plane - Number of Y, U, V, A channels in the ith plane for a given
PlaneConfig(orNoneif i is invalid). - num_
planes - Number of planes for a given
PlaneConfig. - plane_
dimensions - Given image dimensions, a planer configuration, subsampling, and origin, determine the expected size of each plane. Returns the expected planes. The input image dimensions are as displayed (after the planes have been transformed to the intended display orientation). The plane dimensions are output as the planes are stored in memory (may be rotated from image dimensions).
- plane_
subsampling_ factors SubsamplingFactors(Subsampling)ifplane_indexrefers to a U/V plane and otherwise(1, 1)if inputs are valid. Invalid inputs consist of incompatiblePlaneConfigSubsamplingplane_indexcombinations.(0, 0)is returned for invalid inputs.- subsampling_
factors - Ratio of Y/A values to U/V values in x and y.
Type Aliases§
- YUVA
Info - Specifies the structure of planes for a YUV image with optional alpha. The actual planar data is not part of this structure and depending on usage is in external textures or pixmaps.