aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxHeightFieldFormat.html
blob: 3d8ef52cc16807ed9bfd0e8c33e99811d97f273b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightFieldFormat Struct Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxHeightFieldFormat Struct Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxHeightFieldFormat" -->Describes the format of height field samples.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxHeightFieldFlag_8h-source.html">PxHeightFieldFlag.h</a>&gt;</code>
<p>

<p>
<a href="structPxHeightFieldFormat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">Enum</a> { <a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7">eS16_TM</a> =  (1 &lt;&lt; 0)
 }</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Describes the format of height field samples. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d" title="Format of the sample data.">PxHeightFieldDesc.format</a> <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a> </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="d28e3afa439f8ff1df6067288c46d9c5"></a><!-- doxytag: member="PxHeightFieldFormat::Enum" ref="d28e3afa439f8ff1df6067288c46d9c5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structPxHeightFieldFormat.html#d28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7"></a><!-- doxytag: member="eS16_TM" ref="d28e3afa439f8ff1df6067288c46d9c5a8ba1edf74a561d830b5f40e2c3e64e7" args="" -->eS16_TM</em>&nbsp;</td><td>
Height field height data is 16 bit signed integers, followed by triangle materials. 
<p>
Each sample is 32 bits wide arranged as follows:<p>
<div align="center">
<img src="heightFieldFormat_S16_TM.png" alt="heightFieldFormat_S16_TM.png">
</div>
<p>
1) First there is a 16 bit height value. 2) Next, two one byte material indices, with the high bit of each byte reserved for special use. (so the material index is only 7 bits). The high bit of material0 is the tess-flag. The high bit of material1 is reserved for future use.<p>
There are zero or more unused bytes before the next sample depending on PxHeightFieldDesc.sampleStride, where the application may eventually keep its own data.<p>
This is the only format supported at the moment.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxHeightFieldDesc.html#8743d198a4db234d353c1f4d2734d43d" title="Format of the sample data.">PxHeightFieldDesc.format</a> <a class="el" href="classPxHeightFieldDesc.html#ffbec0b3ed43d041b12152648d13821b" title="The samples array.">PxHeightFieldDesc.samples</a> </dd></dl>
</td></tr>
</table>
</dl>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxHeightFieldFlag_8h-source.html">PxHeightFieldFlag.h</a></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>