Perception Tool Kit (PTK) API Guide
c/Renderer.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2018 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 #ifndef C_RENDERER_H
63 #define C_RENDERER_H
64 
65 #include <stdint.h>
66 
68 #include <perception/gui/c/Font.h>
70 
71 #ifdef __cplusplus
72 namespace ptk {
73 extern "C" {
74 #endif
75 
76 struct String;
77 typedef struct String String;
78 struct Renderer;
79 struct KeyHandlerTable;
80 
81 typedef struct Renderer Renderer;
83 
85 typedef struct Renderer * pRenderer;
86 
87 
89 void Renderer_delete(Renderer *obj);
91 void Renderer_createWindow(Renderer *obj, char *name, uint32_t width, uint32_t height);
92 void Renderer_run(Renderer *obj);
93 void Renderer_step(Renderer *obj);
94 void Renderer_setFovYZ(Renderer *obj, float fovY, float nearClip, float farClip);
96 //void Renderer_addRenderable_2(Renderer *obj, pRenderable r);
97 
101 
102 void Renderer_addCameraControls(Renderer *obj, pKeyHandlerTable k, struct ptk_virtual_camera_t* vc);
103 
104 // Font management interface
105 int Renderer_loadFont(Renderer *obj, const char *path, int size);
106 int Renderer_getFontId(Renderer *obj, const char *path, int size);
107 ptk_Font *Renderer_getFont(Renderer *obj, int fontId);
108 void Renderer_setFont(Renderer *obj, int fontId);
109 void Renderer_setColor(Renderer *obj, float r, float g, float b, float a);
110 
111 // String management interface
112 String *Renderer_createString(Renderer *obj, int fontId, const char *source);
113 void Renderer_deleteString(Renderer *obj, String *s);
114 uint32_t Renderer_loadImageFromPath(Renderer *obj, const char *path);
115 void Renderer_loadImageFromPathWithTex(Renderer *obj, const char *path, unsigned int texture);
116 uint32_t Renderer_createTexture(Renderer *obj);
117 uint32_t Renderer_loadImage(Renderer *obj, void *mem, size_t size);
118 uint32_t Renderer_loadImageYUVFromPath(Renderer *obj, const char *path);
119 uint32_t Renderer_loadImageYUV(Renderer *obj, void *mem, size_t size);
120 
121 uint32_t Renderer_getWidth(Renderer *obj);
122 uint32_t Renderer_getHeight(Renderer *obj);
123 void Renderer_getCanvasDimensions(Renderer *obj, uint32_t *x, uint32_t *y, uint32_t *w, uint32_t *h);
124 
125 #ifdef __cplusplus
126 }
127 } // namespace ptk
128 #endif
129 
130 #endif
void Renderer_addCameraControls(Renderer *obj, pKeyHandlerTable k, struct ptk_virtual_camera_t *vc)
uint32_t Renderer_loadImageYUVFromPath(Renderer *obj, const char *path)
ptk_Font * Renderer_getFont(Renderer *obj, int fontId)
struct Font ptk_Font
Definition: c/Font.h:73
uint32_t Renderer_getHeight(Renderer *obj)
String * Renderer_createString(Renderer *obj, int fontId, const char *source)
int Renderer_getFontId(Renderer *obj, const char *path, int size)
pKeyHandlerTable Renderer_createKeyHandlerTable()
uint32_t Renderer_loadImageYUV(Renderer *obj, void *mem, size_t size)
uint32_t Renderer_getWidth(Renderer *obj)
void Renderer_addRenderable(Renderer *obj, pRenderable r, PTK_Dimensions dims)
struct String String
Definition: c/Renderer.h:77
Definition: c/Dimensions.h:72
void Renderer_setFovYZ(Renderer *obj, float fovY, float nearClip, float farClip)
Definition: sensor.h:74
void Renderer_setFont(Renderer *obj, int fontId)
void Renderer_setKeyHandlerTable(Renderer *obj, pKeyHandlerTable k)
struct Renderer Renderer
Definition: c/Renderer.h:81
struct Renderer * pRenderer
Definition: c/Renderer.h:85
uint32_t Renderer_loadImage(Renderer *obj, void *mem, size_t size)
Renderable * pRenderable
Definition: c/Renderable.h:74
uint32_t Renderer_createTexture(Renderer *obj)
void Renderer_deleteString(Renderer *obj, String *s)
struct KeyHandlerTable KeyHandlerTable
Definition: c/Renderer.h:82
struct KeyHandlerTable * pKeyHandlerTable
Definition: c/Renderer.h:84
Renderer * Renderer_createRenderer()
uint32_t Renderer_loadImageFromPath(Renderer *obj, const char *path)
void Renderer_deleteKeyHandlerTable()
void Renderer_createWindow(Renderer *obj, char *name, uint32_t width, uint32_t height)
void Renderer_createConsole(Renderer *obj)
void Renderer_step(Renderer *obj)
void Renderer_delete(Renderer *obj)
int Renderer_loadFont(Renderer *obj, const char *path, int size)
void Renderer_setColor(Renderer *obj, float r, float g, float b, float a)
void Renderer_run(Renderer *obj)
void Renderer_loadImageFromPathWithTex(Renderer *obj, const char *path, unsigned int texture)
void Renderer_getCanvasDimensions(Renderer *obj, uint32_t *x, uint32_t *y, uint32_t *w, uint32_t *h)