is_depth_format()

MAYAFLUX_API bool MayaFlux::Kakshya::is_depth_format

(

ImageFormat

format

)

True when the format's values are range measurements rather than colour.

Governs whether a container declares VIDEO_COLOR or VIDEO_DEPTH, and therefore whether its component axis carries Role::CHANNEL or Role::DEPTH.

Parameters

format

Pixel format.

Definition at line 290 of file PixelStorage.cpp.

{
    switch (format) {
    case ImageFormat::DEPTH16:
    case ImageFormat::DEPTH24:
    case ImageFormat::DEPTH32F:
    case ImageFormat::DEPTH24_STENCIL8:
        return true;
    default:
        return false;
    }
}

References DEPTH16, DEPTH24, DEPTH24_STENCIL8, DEPTH32F, and format.

Referenced by MayaFlux::Kakshya::VideoStreamContainer::setup_ring(), and MayaFlux::Kakshya::VideoStreamContainer::VideoStreamContainer().

Here is the caller graph for this function: