PixelFormat.h

Go to the documentation of this file.

/*
 * Copyright 2020 NVIDIA Corporation. All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee. Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users. These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */
 
#ifndef NV_VPI_PIXEL_FORMAT_H
#define NV_VPI_PIXEL_FORMAT_H
 
#include "Format.h"
#include "detail/FormatUtils.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    VPI_PIXEL_FORMAT_DEFAULT = 0, 
    VPI_PIXEL_FORMAT_INVALID = VPI_PIXEL_FORMAT_DEFAULT,                  
    VPI_PIXEL_FORMAT_U8 = VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, UNSIGNED, X8), 
    VPI_PIXEL_FORMAT_S8 = VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, SIGNED, X8),   
    VPI_PIXEL_FORMAT_U16 =
        VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, UNSIGNED, X16),                  
    VPI_PIXEL_FORMAT_S16 = VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, SIGNED, X16), 
    VPI_PIXEL_FORMAT_2U8 =
        VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, UNSIGNED, X8_Y8), 
    VPI_PIXEL_FORMAT_3U8 = VPI_DETAIL_MAKE_PIXEL_FORMAT(
        PL, UNSIGNED, X8_Y8_Z8), 
    VPI_PIXEL_FORMAT_4U8 = VPI_DETAIL_MAKE_PIXEL_FORMAT(
        PL, UNSIGNED, X8_Y8_Z8_W8), 
    VPI_PIXEL_FORMAT_F32 = VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, FLOAT, X32), 
    VPI_PIXEL_FORMAT_2F32 =
        VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, FLOAT, X32_Y32), 
    VPI_PIXEL_FORMAT_F64 = VPI_DETAIL_MAKE_PIXEL_FORMAT(PL, FLOAT, X64), 
    VPI_PIXEL_FORMAT_FORCE64 = INT64_MAX
    /* \endcond */
} VPIPixelFormat;
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_PIXEL_FORMAT(memLayout, dataType, packing)
#else
#    define VPI_MAKE_PIXEL_FORMAT (VPIPixelFormat) VPI_DETAIL_MAKE_PIXEL_FORMAT
#endif
 
#define vpiMakePixelFormat VPI_APINAME(vpiMakePixelFormat, 004)
#define vpiPixelFormatGetPacking VPI_APINAME(vpiPixelFormatGetPacking, 004)
#define vpiPixelFormatGetBitsPerPixel VPI_APINAME(vpiPixelFormatGetBitsPerPixel, 004)
#define vpiPixelFormatGetDataType VPI_APINAME(vpiPixelFormatGetDataType, 004)
#define vpiPixelFormatGetMemLayout VPI_APINAME(vpiPixelFormatGetMemLayout, 004)
#define vpiPixelFormatGetChannelCount VPI_APINAME(vpiPixelFormatGetChannelCount, 004)
 
VPI_PUBLIC VPIPixelFormat vpiMakePixelFormat(VPIMemLayout memLayout, VPIFormatDataType dataType,
                                             VPIFormatPacking packing);
 
VPI_PUBLIC VPIFormatPacking vpiPixelFormatGetPacking(VPIPixelFormat fmt);
 
VPI_PUBLIC int vpiPixelFormatGetBitsPerPixel(VPIPixelFormat fmt);
 
VPI_PUBLIC VPIFormatDataType vpiPixelFormatGetDataType(VPIPixelFormat fmt);
 
VPI_PUBLIC VPIMemLayout vpiPixelFormatGetMemLayout(VPIPixelFormat fmt);
 
VPI_PUBLIC int vpiPixelFormatGetChannelCount(VPIPixelFormat fmt);
 
#ifdef __cplusplus
}
#endif
 
#endif // NV_VPI_PIXEL_FORMAT_H