Renderer.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// 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 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. 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 products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_RENDERER_RENDERER_H__
#define DW_RENDERER_RENDERER_H__

#include <dw/core/Config.h>
#include <dw/core/Exports.h>
#include <dw/core/Status.h>
#include <dw/core/Types.h>
#include <dw/core/Context.h>

#include <dw/gl/GL.h>

#ifdef __cplusplus
extern "C" {
#endif

//#######################################################################################
const float32_t DW_RENDERER_COLOR_RED[4]        = { 230.0f/255.0f,  72.0f/255.0f,  32.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_DARKRED[4]    = { 180.0f/255.0f,   5.0f/255.0f,   0.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_BLUE[4]       = {  32.0f/255.0f,  72.0f/255.0f, 230.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_GREEN[4]      = {  32.0f/255.0f, 230.0f/255.0f,  32.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_WHITE[4]      = { 230.0f/255.0f, 230.0f/255.0f, 230.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_DARKGREEN[4]  = {  45.0f/255.0f, 100.0f/255.0f,  44.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_LIGHTGREEN[4] = { 118.0f/255.0f, 185.0f/255.0f,   0.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_DARKGREY[4]   = {  72.0f/255.0f,  72.0f/255.0f,  72.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_DARKBLUE[4]   = {  45.0f/255.0f,  44.0f/255.0f, 100.0f/255.0f, 0.6f};
const float32_t DW_RENDERER_COLOR_YELLOW[4]     = { 230.0f/255.0f, 230.0f/255.0f,  10.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_ORANGE[4]     = { 230.0f/255.0f, 100.0f/255.0f,  10.0f/255.0f, 1.0f};
const float32_t DW_RENDERER_COLOR_LIGHTBLUE[4]  = {  51.0f/255.0f, 153.0f/255.0f, 255.0f/255.0f, 0.6f};
const float32_t DW_RENDERER_COLOR_BLACK[4]      = {   0.0f/255.0f,   0.0f/255.0f,   0.0f/255.0f, 1.0f};

static const uint32_t DW_RENDERBUFFER_MAX_VIEWS = 10;

//#######################################################################################
const float32_t DW_RENDER_COLORMAPSCALE_75M[3]           = {  75.0f,  75.0f,  75.0f};
const float32_t DW_RENDER_COLORMAPSCALE_100M[3]          = { 100.0f, 100.0f, 100.0f};
const float32_t DW_RENDER_COLORMAPSCALE_130M[3]          = { 130.0f, 130.0f, 130.0f};
const float32_t DW_RENDER_COLORMAPSCALE_150M[3]          = { 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
} 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_API_PUBLIC
dwStatus dwRenderBuffer_initialize(dwRenderBufferHandle_t *renderbuffer,
                                   const dwRenderBufferVertexLayout layout,
                                   const dwRenderBufferPrimitiveType primType,
                                   const uint32_t primCount,
                                   dwContextHandle_t context);
DW_API_PUBLIC
dwStatus dwRenderBuffer_createView (uint32_t *slot,
                                    dwRenderBufferHandle_t renderbuffer,
                                    const dwRenderBufferVertexLayout newLayout,
                                    const dwRenderBufferPrimitiveType newPrimType,
                                    dwContextHandle_t context);
DW_API_PUBLIC
dwStatus dwRenderBuffer_map (float32_t **map,
                             uint32_t *maxVertices,
                             uint32_t *vertexStride,
                             dwRenderBufferHandle_t renderbuffer);

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

DW_API_PUBLIC
dwStatus dwRenderBuffer_release (dwRenderBufferHandle_t *renderbuffer);

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

//#######################################################################################
// Renderer
//#######################################################################################
DW_API_PUBLIC dwStatus dwRenderer_initialize(dwRendererHandle_t *renderer, dwContextHandle_t context);

DW_API_PUBLIC dwStatus dwRenderer_reset(dwRendererHandle_t renderer);

DW_API_PUBLIC dwStatus dwRenderer_release(dwRendererHandle_t *renderer);

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

DW_API_PUBLIC dwStatus dwRenderer_getColor(float32_t color[4], dwConstRendererHandle_t obj);

DW_API_PUBLIC dwStatus dwRenderer_getColorMapScale(float32_t colorMapScale[3], dwConstRendererHandle_t obj);

DW_API_PUBLIC dwStatus dwRenderer_getColorMapScale(float32_t colorMapScale[3], dwConstRendererHandle_t obj);

DW_API_PUBLIC dwStatus dwRenderer_getModelView(float32_t matrix[16], dwConstRendererHandle_t obj);

DW_API_PUBLIC dwStatus dwRenderer_getProjection(float32_t matrix[16], dwConstRendererHandle_t obj);

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

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

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

DW_API_PUBLIC dwStatus dwRenderer_get2DTransform(float32_t matrix[9], dwConstRendererHandle_t obj);

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

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

DW_API_PUBLIC dwStatus dwRenderer_setColor(const float32_t color[4], dwRendererHandle_t obj) ;

DW_API_PUBLIC dwStatus dwRenderer_setColorMapScale(const float32_t colorMapScale[3], dwRendererHandle_t obj) ;

DW_API_PUBLIC dwStatus dwRenderer_setModelView(const float32_t matrix[16], dwRendererHandle_t obj);

DW_API_PUBLIC dwStatus dwRenderer_setProjection(const float32_t matrix[16], dwRendererHandle_t obj);

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

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

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

DW_API_PUBLIC dwStatus dwRenderer_set2DTransform(const float32_t matrix[9], dwRendererHandle_t obj);


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

DW_API_PUBLIC dwStatus dwRenderer_renderBuffer(dwConstRenderBufferHandle_t buffer, dwRendererHandle_t obj);

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

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

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

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

DW_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_API_PUBLIC dwStatus dwRenderer_renderText(const int32_t x, const int32_t y, const char *text,
                                             dwRendererHandle_t obj);

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

#ifdef __cplusplus
}
#endif

#endif // DW_RENDERER_RENDERER_H__