9.1/sources/includes/nvll_osd_struct.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NVLL_OSD_STRUCT_DEFS__
#define __NVLL_OSD_STRUCT_DEFS__
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum {
    MODE_CPU, 
    MODE_GPU, 
    MODE_NONE 
} NvOSD_Mode;
 
typedef enum
{
  START_HEAD,
  END_HEAD,
  BOTH_HEAD
} NvOSD_Arrow_Head_Direction;
 
typedef struct _NvBbox_Coords {
  float left;            
  float top;             
  float width;           
  float height;          
} NvBbox_Coords;
 
typedef struct _NvOSD_ColorParams {
  double red;     
  double green;   
  double blue;    
  double alpha;   
} NvOSD_ColorParams;
 
typedef struct _NvOSD_FontParams {
  char * font_name;             
//  char font_name[64];         /**< Holds a pointer to a string containing
//                               the font name. */
 
  unsigned int font_size;       
  NvOSD_ColorParams font_color; 
} NvOSD_FontParams;
 
 
typedef struct _NvOSD_TextParams {
  char * display_text;          
  unsigned int x_offset;        
  unsigned int y_offset;        
  NvOSD_FontParams font_params; 
  int set_bg_clr;               
  NvOSD_ColorParams text_bg_clr;
} NvOSD_TextParams;
 
typedef struct _NvOSD_Color_info {
    int id;
    NvOSD_ColorParams color;
}NvOSD_Color_info;
 
typedef struct _NvOSD_RectParams {
  float left;            
  float top;             
  float width;           
  float height;          
  unsigned int border_width;    
  NvOSD_ColorParams border_color;
  unsigned int has_bg_color;    
  unsigned int reserved;        
  NvOSD_ColorParams bg_color;   
  int has_color_info;
  int color_id;
 
  float rotation_angle;           
} NvOSD_RectParams;
 
typedef struct _NvOSD_MaskParams {
  float *data;                   
  unsigned int size;             
  float threshold;               
  unsigned int width;            
  unsigned int height;           
} NvOSD_MaskParams;
 
typedef struct _NvOSD_LineParams {
  unsigned int x1;              
  unsigned int y1;              
  unsigned int x2;              
  unsigned int y2;              
  unsigned int line_width;      
  NvOSD_ColorParams line_color; 
} NvOSD_LineParams;
 
typedef struct _NvOSD_ArrowParams {
  unsigned int x1;   
  unsigned int y1;    
  unsigned int x2;  
  unsigned int y2; 
  unsigned int arrow_width; 
  NvOSD_Arrow_Head_Direction arrow_head;
  NvOSD_ColorParams arrow_color;
  unsigned int reserved;    
} NvOSD_ArrowParams;
 
typedef struct _NvOSD_CircleParams {
  unsigned int xc;   
  unsigned int yc;    
  unsigned int radius;  
  NvOSD_ColorParams circle_color;
  unsigned int has_bg_color;   /*< Holds a Boolean value indicating whether
                                   the circle has a background color. */
 
  NvOSD_ColorParams bg_color;  /*< Holds the circle's background color. */
 
  unsigned int circle_width;  
  unsigned int reserved; 
} NvOSD_CircleParams;
 
#ifdef __cplusplus
}
#endif
 
#endif