RenderManAPI  24.0
brickmap.h
Go to the documentation of this file.
1 /*
2 # ------------------------------------------------------------------------------
3 #
4 # Copyright (c) 2020 Pixar. All rights reserved.
5 #
6 # The information in this file (the "Software") is provided for the exclusive
7 # use of the software licensees of Pixar ("Licensees"). Licensees have the
8 # right to incorporate the Software into other products for use by other
9 # authorized software licensees of Pixar, without fee. Except as expressly
10 # permitted herein, the Software may not be disclosed to third parties, copied
11 # or duplicated in any form, in whole or in part, without the prior written
12 # permission of Pixar.
13 #
14 # The copyright notices in the Software and this entire statement, including the
15 # above license grant, this restriction and the following disclaimer, must be
16 # included in all copies of the Software, in whole or in part, and all permitted
17 # derivative works of the Software, unless such copies or derivative works are
18 # solely in the form of machine-executable object code generated by a source
19 # language processor.
20 #
21 # PIXAR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL PIXAR BE
23 # LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
24 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
25 # OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
26 # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. IN NO CASE WILL
27 # PIXAR'S TOTAL LIABILITY FOR ALL DAMAGES ARISING OUT OF OR IN CONNECTION WITH
28 # THE USE OR PERFORMANCE OF THIS SOFTWARE EXCEED $50.
29 #
30 # Pixar
31 # 1200 Park Ave
32 # Emeryville CA 94608
33 #
34 # ------------------------------------------------------------------------------
35 */
36 
37 #ifndef _BRICKMAP_H_
38 #define _BRICKMAP_H_
39 
40 #include "prmanapi.h" // for PRMANAPI
41 
42 typedef void* BkmBrickMap;
43 typedef void* BkmBrickMapNode; // was unsigned int in API version 2
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 /* Brick map API version number */
50 #define RMAN_BRICKMAP_API_VERSION 3
51 
52 /* Brick map API */
53 PRMANAPI extern BkmBrickMap BkmOpenBrickMapFile(char* filename);
54 PRMANAPI extern int BkmGetBrickMapInfo(
55  BkmBrickMap brickmap,
56  char const* request,
57  void* result);
58 PRMANAPI extern int BkmGetOctreeRoots(
59  BkmBrickMap brickmap,
60  BkmBrickMapNode roots[7]);
62  BkmBrickMapNode node,
63  BkmBrickMapNode children[8]);
65  BkmBrickMap brickmap, // new param!
66  BkmBrickMapNode node,
67  BkmBrickMapNode children[8]);
68 PRMANAPI extern int BkmGetVoxelData(
69  BkmBrickMap brickmap,
70  BkmBrickMapNode node,
71  int imin,
72  int jmin,
73  int kmin,
74  int imax,
75  int jmax,
76  int kmax,
77  int* nvoxels,
78  int* voxelnumbers,
79  int* voxelhasdata, // (redundant, but useful)
80  float* voxeldata);
81 PRMANAPI extern void BkmCloseBrickMapFile(BkmBrickMap brickmap);
82 
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 #endif /* _BRICKMAP_H_ */
PRMANAPI int BkmGetOctreeChildrenList(BkmBrickMap brickmap, BkmBrickMapNode node, BkmBrickMapNode children[8])
PRMANAPI void BkmCloseBrickMapFile(BkmBrickMap brickmap)
#define PRMANAPI
Definition: prmanapi.h:124
PRMANAPI BkmBrickMap BkmOpenBrickMapFile(char *filename)
void * BkmBrickMap
Definition: brickmap.h:42
PRMANAPI int BkmGetOctreeChildren(BkmBrickMapNode node, BkmBrickMapNode children[8])
PRMANAPI int BkmGetVoxelData(BkmBrickMap brickmap, BkmBrickMapNode node, int imin, int jmin, int kmin, int imax, int jmax, int kmax, int *nvoxels, int *voxelnumbers, int *voxelhasdata, float *voxeldata)
PRMANAPI int BkmGetOctreeRoots(BkmBrickMap brickmap, BkmBrickMapNode roots[7])
void * BkmBrickMapNode
Definition: brickmap.h:43
PRMANAPI int BkmGetBrickMapInfo(BkmBrickMap brickmap, char const *request, void *result)