Renderer.h

Go to the documentation of this file.

//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//

#ifndef DWVISUALIZATION_RENDERER_H_
#define DWVISUALIZATION_RENDERER_H_

#include <dwvisualization/core/Visualization.h>

#include <dwvisualization/gl/GL.h>

#ifdef __cplusplus
extern "C" {
#endif

//#######################################################################################
const dwVector4f DW_RENDERER_COLOR_BLACK     = {0.0f / 255.0f, 0.0f / 255.0f, 0.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_WHITE     = {255.0f / 255.0f, 255.0f / 255.0f, 255.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_DARKGREY  = {72.0f / 255.0f, 72.0f / 255.0f, 72.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTGREY = {185.0f / 255.0f, 185.0f / 255.0f, 185.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_DARKBLUE  = {45.0f / 255.0f, 44.0f / 255.0f, 100.0f / 255.0f, 0.6f};
const dwVector4f DW_RENDERER_COLOR_BLUE      = {32.0f / 255.0f, 72.0f / 255.0f, 230.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTBLUE = {51.0f / 255.0f, 153.0f / 255.0f, 255.0f / 255.0f, 0.6f};

const dwVector4f DW_RENDERER_COLOR_DARKCYAN  = {5.0f / 255.0f, 150.0f / 255.0f, 150.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_CYAN      = {40.0f / 255.0f, 130.0f / 255.0f, 255.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTCYAN = {150.0f / 255.0f, 230.0f / 255.0f, 230.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_DARKGREEN    = {45.0f / 255.0f, 100.0f / 255.0f, 44.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_GREEN        = {32.0f / 255.0f, 230.0f / 255.0f, 32.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTGREEN   = {118.0f / 255.0f, 185.0f / 255.0f, 0.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_NVIDIA_GREEN = {0.4609375f, 0.72265625f, 0.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIME         = {227.0f / 255.0f, 255.0f / 255.0f, 0.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_DARKYELLOW  = {242.0f / 255.0f, 186.0f / 255.0f, 73.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_YELLOW      = {230.0f / 255.0f, 230.0f / 255.0f, 10.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTYELLOW = {253.0f / 255.0f, 255.0f / 255.0f, 0.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_ORANGE = {230.0f / 255.0f, 100.0f / 255.0f, 10.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_DARKRED  = {180.0f / 255.0f, 5.0f / 255.0f, 0.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_RED      = {230.0f / 255.0f, 72.0f / 255.0f, 32.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTRED = {250.0f / 255.0f, 100.0f / 255.0f, 100.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_DARKMAGENTA  = {120.0f / 255.0f, 50.0f / 255.0f, 120.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_MAGENTA      = {230.f / 255.f, 25.f / 255.f, 230.f / 255.f, 1.f};
const dwVector4f DW_RENDERER_COLOR_LIGHTMAGENTA = {170.0f / 255.0f, 100.0f / 255.0f, 170.0f / 255.0f, 1.0f};

const dwVector4f DW_RENDERER_COLOR_DARKPURPLE  = {81.0f / 255.0f, 4.0f / 255.0f, 189.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_PURPLE      = {255.0f / 255.0f, 0.0f / 255.0f, 240.0f / 255.0f, 1.0f};
const dwVector4f DW_RENDERER_COLOR_LIGHTPURPLE = {181.0f / 255.0f, 138.0f / 255.0f, 242.0f / 255.0f, 1.0f};

const dwVector3f DW_RENDERER_HSV_RED    = {0.0f, 1.0f, 0.75f};
const dwVector3f DW_RENDERER_HSV_BLUE   = {240.0f, 1.0f, 0.75f};
const dwVector3f DW_RENDERER_HSV_PURPLE = {270.0f, 1.0f, 0.75f};

static const uint32_t DW_RENDERBUFFER_MAX_VIEWS = 10;

//#######################################################################################
const dwVector3f DW_RENDER_COLORMAPSCALE_75M  = {75.0f, 75.0f, 75.0f};
const dwVector3f DW_RENDER_COLORMAPSCALE_100M = {100.0f, 100.0f, 100.0f};
const dwVector3f DW_RENDER_COLORMAPSCALE_130M = {130.0f, 130.0f, 130.0f};
const dwVector3f DW_RENDER_COLORMAPSCALE_150M = {150.0f, 150.0f, 150.0f};

//#######################################################################################
typedef enum dwRendererFonts {
    DW_RENDER_FONT_VERDANA_8  = 0,
    DW_RENDER_FONT_VERDANA_12 = 1,
    DW_RENDER_FONT_VERDANA_16 = 2,
    DW_RENDER_FONT_VERDANA_20 = 3,
    DW_RENDER_FONT_VERDANA_24 = 4,
    DW_RENDER_FONT_VERDANA_32 = 5,
    DW_RENDER_FONT_VERDANA_48 = 6,
    DW_RENDER_FONT_VERDANA_64 = 7,
    DW_RENDER_FONT_COUNT
} dwRendererFonts;

//#######################################################################################
typedef enum dwRenderBufferFormat {
    DW_RENDER_FORMAT_NULL               = 0,
    DW_RENDER_FORMAT_R32G32B32A32_FLOAT = 1,
    DW_RENDER_FORMAT_R32G32B32_FLOAT    = 2,
    DW_RENDER_FORMAT_R32G32_FLOAT       = 3,
    DW_RENDER_FORMAT_R32_FLOAT          = 4
} dwRenderBufferFormat;

typedef enum dwRenderBufferPositionSemantic {
    DW_RENDER_SEMANTIC_POS_NULL = 0,
    DW_RENDER_SEMANTIC_POS_XY   = 1,
    DW_RENDER_SEMANTIC_POS_XYZ  = 2,
} dwRenderBufferPositionSemantic;

typedef enum dwRenderBufferColorSemantic {
    DW_RENDER_SEMANTIC_COL_NULL = 0,
    DW_RENDER_SEMANTIC_COL_R    = 1,
    DW_RENDER_SEMANTIC_COL_A    = 2,
    DW_RENDER_SEMANTIC_COL_RGB  = 3,
    DW_RENDER_SEMANTIC_COL_RGBA = 4,
    DW_RENDER_SEMANTIC_COL_LUT  = 5,
    DW_RENDER_SEMANTIC_COL_HUE  = 6
} dwRenderBufferColorSemantic;

typedef enum dwRenderBufferTexSemantic {
    DW_RENDER_SEMANTIC_TEX_NULL = 0,
    DW_RENDER_SEMANTIC_TEX_S    = 1,
    DW_RENDER_SEMANTIC_TEX_ST   = 2
} dwRenderBufferTexSemantic;

typedef struct dwRenderBufferVertexLayout
{
    dwRenderBufferFormat posFormat;             
    dwRenderBufferPositionSemantic posSemantic; 
    dwRenderBufferFormat colFormat;             
    dwRenderBufferColorSemantic colSemantic;    
    dwRenderBufferFormat texFormat;             
    dwRenderBufferTexSemantic texSemantic;      
} dwRenderBufferVertexLayout;

typedef enum dwRenderBufferPrimitiveType {
    DW_RENDER_PRIM_POINTLIST    = 0,
    DW_RENDER_PRIM_LINELIST     = 1,
    DW_RENDER_PRIM_TRIANGLELIST = 2,
    DW_RENDER_PRIM_LINESTRIP    = 3,
    DW_RENDER_PRIM_LINELOOP     = 4,
    DW_RENDER_PRIM_COUNT        = 5
} dwRenderBufferPrimitiveType;

static const uint32_t DW_RENDERER_DEFAULT_BUFFER_SIZE = 10000;

typedef struct dwRenderBufferObject* dwRenderBufferHandle_t;

typedef const struct dwRenderBufferObject* dwConstRenderBufferHandle_t;

typedef struct dwRendererObject* dwRendererHandle_t;

typedef const struct dwRendererObject* dwConstRendererHandle_t;

//#######################################################################################
// RenderBuffer
//#######################################################################################

DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_initialize(dwRenderBufferHandle_t* renderbuffer,
                                   const dwRenderBufferVertexLayout layout,
                                   const dwRenderBufferPrimitiveType primType,
                                   const uint32_t primCount,
                                   dwVisualizationContextHandle_t context);
DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_createView(uint32_t* slot,
                                   dwRenderBufferHandle_t renderbuffer,
                                   const dwRenderBufferVertexLayout newLayout,
                                   const dwRenderBufferPrimitiveType newPrimType,
                                   dwVisualizationContextHandle_t context);
DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_map(float32_t** map,
                            uint32_t* maxVertices,
                            uint32_t* vertexStride,
                            dwRenderBufferHandle_t renderbuffer);

DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_mapRange(float32_t** map,
                                 uint32_t* maxVertices,
                                 uint32_t* vertexStride,
                                 const uint32_t startVertex,
                                 dwRenderBufferHandle_t renderbuffer);
DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_unmap(uint32_t nVerts, dwRenderBufferHandle_t renderbuffer);

DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_release(dwRenderBufferHandle_t renderbuffer);

DW_VIZ_API_PUBLIC
dwStatus dwRenderBuffer_set2DCoordNormalizationFactors(const float32_t width, const float32_t height,
                                                       dwRenderBufferHandle_t renderbuffer);

//#######################################################################################
// Renderer
//#######################################################################################
DW_VIZ_API_PUBLIC
dwStatus dwRenderer_initialize(dwRendererHandle_t* renderer, dwVisualizationContextHandle_t context);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_reset(dwRendererHandle_t renderer);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_release(dwRendererHandle_t renderer);

//#######################################################################################
// Get state
//#######################################################################################
DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getRect(dwRect* rect, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getColor(dwVector4f* color, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getColorMapScale(dwVector3f* colorMapScale, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getModelView(dwMatrix4f* matrix, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getProjection(dwMatrix4f* matrix, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getPointSize(float32_t* value, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getLineWidth(float32_t* value, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_getFont(dwRendererFonts* value, dwConstRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_get2DTransform(dwMatrix3f* matrix, dwConstRendererHandle_t obj);

//#######################################################################################
// Set state
//#######################################################################################

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setRect(const dwRect rect, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setViewportAndScissorRects(const dwRect viewport, const dwRect scissor, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setColor(const dwVector4f color, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setColorMapScale(const dwVector3f colorMapScale, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setModelView(const dwMatrix4f* matrix, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setProjection(const dwMatrix4f* matrix, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setPointSize(const float32_t value, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setLineWidth(const float32_t value, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_setFont(const dwRendererFonts value, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_set2DTransform(const dwMatrix3f* matrix, dwRendererHandle_t obj);

//#######################################################################################
// Render calls
//#######################################################################################

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderBuffer(dwConstRenderBufferHandle_t buffer, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderData2D(const dwVector2f* buffer, size_t count, dwRenderBufferPrimitiveType primitiveType, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderData3D(const dwVector3f* buffer, size_t count, dwRenderBufferPrimitiveType primitiveType, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderCircle(dwVector2f center, float32_t radius, dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderTexture(const GLuint inputTexture, const GLenum textureTarget,
                                  dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderSubTexture(const GLuint inputTexture, const GLenum textureTarget,
                                     const float32_t minx, const float32_t miny,
                                     const float32_t maxx, const float32_t maxy,
                                     dwRendererHandle_t obj);
DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderText(const int32_t x, const int32_t y, const char* text,
                               dwRendererHandle_t obj);

DW_VIZ_API_PUBLIC
dwStatus dwRenderer_renderTextNorm(const float32_t normX, const float32_t normY,
                                   const char* text,
                                   dwRendererHandle_t obj);

#ifdef __cplusplus
}
#endif

#endif // DW_VISUALIZATION_RENDERER_H_