PixelType.h

前往此文件的文档。

/*
 * 版权所有 2020-2021 英伟达公司。保留所有权利。
 *
 * 致许可方的通知：
 *
 * 此源代码和/或文档（“许可交付物”）受美国和
 * 国际版权法项下的英伟达知识产权保护。
 *
 * 此处包含的这些许可交付物是英伟达的专有和
 * 机密信息，并根据英伟达与
 * 许可方（“许可协议”）之间或由许可方以电子方式
 * 接受的 NVIDIA 软件许可协议条款和条件提供。 尽管许可协议中有任何相反的条款或条件，
 *
 * 未经英伟达明确书面同意，禁止将许可交付物复制或披露
 *
 * 给任何第三方。
 *
 * 尽管许可协议中有任何相反的条款或条件，
 *
 * 英伟达对这些许可交付物对任何用途的适用性不做任何陈述。
 *
 * 它们按“原样”提供，不附带任何明示或暗示的担保。
 *
 * 英伟达不对这些许可交付物承担任何担保责任，包括对适销性、
 * 非侵权性以及特定用途适用性的所有默示担保。
 *
 * 尽管许可协议中有任何相反的条款或条件，在任何情况下，英伟达均不对任何
 *
 * 特殊、间接、附带或后果性损害，或因使用、数据或利润损失而导致的任何
 *
 * 损害承担责任，无论是在合同诉讼、过失或其他侵权
 *
 * 行为中，还是因使用或执行这些许可交付物而引起或与之相关的。
 *
 * 美国政府最终用户。 这些许可交付物是
 *
 * “商业项目”，该术语在 48 C.F.R. 2.101 (OCT
 *
 * 1995) 中定义，包括“商业计算机软件”和“商业
 *
 * 计算机软件文档”，这些术语在 48
 *
 * C.F.R. 12.212 (SEPT 1995) 中使用，并且仅作为商业最终项目提供给美国政府。
 *
 * 与 48 C.F.R. 12.212 和
 *
 * 48 C.F.R. 227.7202-1 至 227.7202-4 (JUNE 1995) 一致，所有
 *
 * 美国政府最终用户仅获得此处规定的权利而获得许可交付物。
 *
 * 在个人和商业软件中对许可交付物的任何使用都必须在用户文档和内部
 *
 * 代码注释中包含上述免责声明和美国政府最终用户通知。
 *
 */

#ifndef NV_VPI_PIXEL_TYPE_H
#define NV_VPI_PIXEL_TYPE_H

#include "DataLayout.h"
#include "detail/FormatUtils.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef uint64_t VPIPixelType;

/* clang-format off */

#define VPI_PIXEL_TYPE_DEFAULT ((VPIPixelType)0)
#define VPI_PIXEL_TYPE_INVALID VPI_PIXEL_TYPE_DEFAULT

#define VPI_PIXEL_TYPE_U8 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X8)
#define VPI_PIXEL_TYPE_2U8 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X8_Y8)
#define VPI_PIXEL_TYPE_3U8 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X8_Y8_Z8)
#define VPI_PIXEL_TYPE_4U8 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X8_Y8_Z8_W8)

#define VPI_PIXEL_TYPE_S8 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X8)
#define VPI_PIXEL_TYPE_2S8 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X8_Y8)
#define VPI_PIXEL_TYPE_3S8 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X8_Y8_Z8)
#define VPI_PIXEL_TYPE_4S8 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X8_Y8_Z8_W8)

#define VPI_PIXEL_TYPE_U16 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X16)
#define VPI_PIXEL_TYPE_2U16 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X16_Y16)
#define VPI_PIXEL_TYPE_3U16 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X16_Y16_Z16)
#define VPI_PIXEL_TYPE_4U16 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X16_Y16_Z16_W16)

#define VPI_PIXEL_TYPE_S16 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X16)
#define VPI_PIXEL_TYPE_2S16 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X16_Y16)
#define VPI_PIXEL_TYPE_3S16 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X16_Y16_Z16)
#define VPI_PIXEL_TYPE_4S16 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X16_Y16_Z16_W16)

#define VPI_PIXEL_TYPE_U32 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X32)
#define VPI_PIXEL_TYPE_2U32 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X32_Y32)
#define VPI_PIXEL_TYPE_3U32 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X32_Y32_Z32)
#define VPI_PIXEL_TYPE_4U32 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X32_Y32_Z32_W32)

#define VPI_PIXEL_TYPE_S32 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X32)
#define VPI_PIXEL_TYPE_2S32 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X32_Y32)
#define VPI_PIXEL_TYPE_3S32 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X32_Y32_Z32)
#define VPI_PIXEL_TYPE_4S32 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X32_Y32_Z32_W32)

#define VPI_PIXEL_TYPE_F32 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X32)
#define VPI_PIXEL_TYPE_2F32 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X32_Y32)
#define VPI_PIXEL_TYPE_3F32 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X32_Y32_Z32)
#define VPI_PIXEL_TYPE_4F32 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X32_Y32_Z32_W32)

#define VPI_PIXEL_TYPE_U64 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X64)
#define VPI_PIXEL_TYPE_2U64 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X64_Y64)
#define VPI_PIXEL_TYPE_3U64 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X64_Y64_Z64)
#define VPI_PIXEL_TYPE_4U64 VPI_DETAIL_MAKE_PIX_TYPE(PL, UNSIGNED, X64_Y64_Z64_W64)

#define VPI_PIXEL_TYPE_S64 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X64)
#define VPI_PIXEL_TYPE_2S64 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X64_Y64)
#define VPI_PIXEL_TYPE_3S64 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X64_Y64_Z64)
#define VPI_PIXEL_TYPE_4S64 VPI_DETAIL_MAKE_PIX_TYPE(PL, SIGNED, X64_Y64_Z64_W64)

#define VPI_PIXEL_TYPE_F64 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X64)
#define VPI_PIXEL_TYPE_2F64 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X64_Y64)
#define VPI_PIXEL_TYPE_3F64 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X64_Y64_Z64)
#define VPI_PIXEL_TYPE_4F64 VPI_DETAIL_MAKE_PIX_TYPE(PL, FLOAT, X64_Y64_Z64_W64)

/* clang-format on */

#ifdef VPI_DOXYGEN
# define VPI_MAKE_PIXEL_TYPE_ABBREV(memLayout, dataType, packing)
#else
# define VPI_MAKE_PIXEL_TYPE_ABBREV (VPIPixelType) VPI_DETAIL_MAKE_PIX_TYPE
#endif

#ifdef VPI_DOXYGEN
# define VPI_MAKE_PIXEL_TYPE(memLayout, dataType, packing)
#else
# define VPI_MAKE_PIXEL_TYPE (VPIPixelType) VPI_DETAIL_MAKE_PIXEL_TYPE
#endif

VPI_PUBLIC VPIPixelType vpiMakePixelType(VPIMemLayout memLayout, VPIDataType dataType, VPIPacking packing);

VPI_PUBLIC VPIPacking vpiPixelTypeGetPacking(VPIPixelType type);

VPI_PUBLIC int vpiPixelTypeGetBitsPerPixel(VPIPixelType type);

VPI_PUBLIC void vpiPixelTypeGetBitsPerChannel(VPIPixelType type, int32_t *bits);

VPI_PUBLIC VPIDataType vpiPixelTypeGetDataType(VPIPixelType type);

VPI_PUBLIC VPIMemLayout vpiPixelTypeGetMemLayout(VPIPixelType type);

VPI_PUBLIC VPIPixelType vpiPixelTypeSetMemLayout(VPIPixelType type, VPIMemLayout layout);

VPI_PUBLIC int vpiPixelTypeGetChannelCount(VPIPixelType type);

VPI_PUBLIC const char *vpiPixelTypeGetName(VPIPixelType type);