Skip to content

Commit c456134

Browse files
ShaunaGordonShaunaGordon
committed
Update API docs to match o3de/main
Signed-off-by: Shauna Gordon <shauna@shaunagordon.com>
1 parent 53400bd commit c456134

File tree

32,277 files changed

+987300
-784061
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

32,277 files changed

+987300
-784061
lines changed

‎content/frameworks/_index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: O3DE Framework API reference
3+
description: Reference index for Open 3D Engine frameworks.
4+
---
5+
6+
* [AtomCore](/docs/api/frameworks/AtomCore)
7+
* [AzAndroid](/docs/api/frameworks/AzAndroid)
8+
* [AzCore](/docs/api/frameworks/AzCore)
9+
* [AzFramework](/docs/api/frameworks/AzFramework)
10+
* [AzGameFramework](/docs/api/frameworks/AzGameFramework)
11+
* [AzManipulatorTestFramework](/docs/api/frameworks/AzManipulatorTestFramework)
12+
* [AzNetworking](/docs/api/frameworks/AzNetworking)
13+
* [AzQtComponents](/docs/api/frameworks/AzQtComponents)
14+
* [AzTest](/docs/api/frameworks/AzTest)
15+
* [AzToolsFramework](/docs/api/frameworks/AzToolsFramework)

‎content/gems/_index.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: O3DE Gem API reference
3+
description: Reference index for Gems shipped with Open 3D Engine.
4+
---
5+
6+
* [Achievements](/docs/api/gems/Achievements)
7+
* [Archive](/docs/api/gems/Archive)
8+
* [AssetValidation](/docs/api/gems/AssetValidation)
9+
* [Atom](/docs/api/gems/Atom)
10+
* [AtomContent](/docs/api/gems/AtomContent)
11+
* [AtomLyIntegration](/docs/api/gems/AtomLyIntegration)
12+
* [AtomTressFX](/docs/api/gems/AtomTressFX)
13+
* [AudioEngineWwise](/docs/api/gems/AudioEngineWwise)
14+
* [AudioSystem](/docs/api/gems/AudioSystem)
15+
* [AWSClientAuth](/docs/api/gems/AWSClientAuth)
16+
* [AWSCore](/docs/api/gems/AWSCore)
17+
* [AWSGameLift](/docs/api/gems/AWSGameLift)
18+
* [AWSMetrics](/docs/api/gems/AWSMetrics)
19+
* [BarrierInput](/docs/api/gems/BarrierInput)
20+
* [Camera](/docs/api/gems/Camera)
21+
* [CameraFramework](/docs/api/gems/CameraFramework)
22+
* [CertificateManager](/docs/api/gems/CertificateManager)
23+
* [Compression](/docs/api/gems/Compression)
24+
* [CrashReporting](/docs/api/gems/CrashReporting)
25+
* [CustomAssetExample](/docs/api/gems/CustomAssetExample)
26+
* [DebugDraw](/docs/api/gems/DebugDraw)
27+
* [DevTextures](/docs/api/gems/DevTextures)
28+
* [DiffuseProbeGrid](/docs/api/gems/DiffuseProbeGrid)
29+
* [EditorPythonBindings](/docs/api/gems/EditorPythonBindings)
30+
* [EMotionFX](/docs/api/gems/EMotionFX)
31+
* [ExpressionEvaluation](/docs/api/gems/ExpressionEvaluation)
32+
* [FastNoise](/docs/api/gems/FastNoise)
33+
* [GameState](/docs/api/gems/GameState)
34+
* [GameStateSamples](/docs/api/gems/GameStateSamples)
35+
* [Gestures](/docs/api/gems/Gestures)
36+
* [GradientSignal](/docs/api/gems/GradientSignal)
37+
* [GraphCanvas](/docs/api/gems/GraphCanvas)
38+
* [GraphModel](/docs/api/gems/GraphModel)
39+
* [HttpRequestor](/docs/api/gems/HttpRequestor)
40+
* [ImGui](/docs/api/gems/ImGui)
41+
* [InAppPurchases](/docs/api/gems/InAppPurchases)
42+
* [LandscapeCanvas](/docs/api/gems/LandscapeCanvas)
43+
* [LmbrCentral](/docs/api/gems/LmbrCentral)
44+
* [LocalUser](/docs/api/gems/LocalUser)
45+
* [LyShine](/docs/api/gems/LyShine)
46+
* [LyShineExamples](/docs/api/gems/LyShineExamples)
47+
* [Maestro](/docs/api/gems/Maestro)
48+
* [Meshlets](/docs/api/gems/Meshlets)
49+
* [MessagePopup](/docs/api/gems/MessagePopup)
50+
* [Metastream](/docs/api/gems/Metastream)
51+
* [Microphone](/docs/api/gems/Microphone)
52+
* [MiniAudio](/docs/api/gems/MiniAudio)
53+
* [MotionMatching](/docs/api/gems/MotionMatching)
54+
* [Multiplayer](/docs/api/gems/Multiplayer)
55+
* [MultiplayerCompression](/docs/api/gems/MultiplayerCompression)
56+
* [NvCloth](/docs/api/gems/NvCloth)
57+
* [PhysX](/docs/api/gems/PhysX)
58+
* [Prefab](/docs/api/gems/Prefab)
59+
* [Presence](/docs/api/gems/Presence)
60+
* [PrimitiveAssets](/docs/api/gems/PrimitiveAssets)
61+
* [Profiler](/docs/api/gems/Profiler)
62+
* [PythonAssetBuilder](/docs/api/gems/PythonAssetBuilder)
63+
* [QtForPython](/docs/api/gems/QtForPython)
64+
* [RecastNavigation](/docs/api/gems/RecastNavigation)
65+
* [RemoteTools](/docs/api/gems/RemoteTools)
66+
* [SaveData](/docs/api/gems/SaveData)
67+
* [SceneLoggingExample](/docs/api/gems/SceneLoggingExample)
68+
* [SceneProcessing](/docs/api/gems/SceneProcessing)
69+
* [ScriptAutomation](/docs/api/gems/ScriptAutomation)
70+
* [ScriptCanvas](/docs/api/gems/ScriptCanvas)
71+
* [ScriptCanvasDeveloper](/docs/api/gems/ScriptCanvasDeveloper)
72+
* [ScriptCanvasPhysics](/docs/api/gems/ScriptCanvasPhysics)
73+
* [ScriptCanvasTesting](/docs/api/gems/ScriptCanvasTesting)
74+
* [ScriptedEntityTweener](/docs/api/gems/ScriptedEntityTweener)
75+
* [ScriptEvents](/docs/api/gems/ScriptEvents)
76+
* [Stars](/docs/api/gems/Stars)
77+
* [StartingPointCamera](/docs/api/gems/StartingPointCamera)
78+
* [StartingPointInput](/docs/api/gems/StartingPointInput)
79+
* [StartingPointMovement](/docs/api/gems/StartingPointMovement)
80+
* [Streamer](/docs/api/gems/Streamer)
81+
* [SurfaceData](/docs/api/gems/SurfaceData)
82+
* [Terrain](/docs/api/gems/Terrain)
83+
* [TestAssetBuilder](/docs/api/gems/TestAssetBuilder)
84+
* [TextureAtlas](/docs/api/gems/TextureAtlas)
85+
* [TickBusOrderViewer](/docs/api/gems/TickBusOrderViewer)
86+
* [Twitch](/docs/api/gems/Twitch)
87+
* [UiBasics](/docs/api/gems/UiBasics)
88+
* [Vegetation](/docs/api/gems/Vegetation)
89+
* [VideoPlaybackFramework](/docs/api/gems/VideoPlaybackFramework)
90+
* [VirtualGamepad](/docs/api/gems/VirtualGamepad)
91+
* [WhiteBox](/docs/api/gems/WhiteBox)

‎frameworks/AtomCore/annotated.html‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.9.6"/>
6+
<meta name="generator" content="Doxygen 1.12.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Open 3D Engine AtomCore API Reference: Class List</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript">var page_layout=1;</script>
1111
<script type="text/javascript" src="jquery.js"></script>
1212
<script type="text/javascript" src="dynsections.js"></script>
13+
<script type="text/javascript" src="clipboard.js"></script>
1314
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14-
<script type="text/javascript" src="resize.js"></script>
1515
<script type="text/javascript" src="navtreedata.js"></script>
1616
<script type="text/javascript" src="navtree.js"></script>
17+
<script type="text/javascript" src="resize.js"></script>
18+
<script type="text/javascript" src="cookie.js"></script>
1719
<link href="doxygen.css" rel="stylesheet" type="text/css" />
1820
</head>
1921
<body>
@@ -24,7 +26,7 @@
2426
<tbody>
2527
<tr id="projectrow">
2628
<td id="projectalign">
27-
<div id="projectname">Open 3D Engine AtomCore API Reference<span id="projectnumber">&#160;23.10.0</span>
29+
<div id="projectname">Open 3D Engine AtomCore API Reference<span id="projectnumber">&#160;24.09.1</span>
2830
</div>
2931
<div id="projectbrief">O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.</div>
3032
</td>
@@ -33,7 +35,12 @@
3335
</table>
3436
</div>
3537
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.9.6 -->
38+
<!-- Generated by Doxygen 1.12.0 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
41+
$(function() { codefold.init(0); });
42+
/* @license-end */
43+
</script>
3744
</div><!-- top -->
3845
<div id="nav-tree">
3946
<div id="nav-tree-contents">
@@ -46,7 +53,7 @@
4653
</div>
4754
<script type="text/javascript">
4855
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
49-
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
56+
$(function(){initNavTree('annotated.html',''); initResizable(true); });
5057
/* @license-end */
5158
</script>
5259
<div id="doc-content">
@@ -55,16 +62,16 @@
5562
</div><!--header-->
5663
<div class="contents">
5764
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
58-
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
59-
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>AZ</b></td><td class="desc"></td></tr>
60-
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>Data</b></td><td class="desc"></td></tr>
65+
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span>]</div><table class="directory">
66+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>AZ</b></td><td class="desc"></td></tr>
67+
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="dynsection.toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>Data</b></td><td class="desc"></td></tr>
6168
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_1_1_data_1_1_instance_data.html" target="_self">InstanceData</a></td><td class="desc"></td></tr>
6269
<tr id="row_0_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_1_1_data_1_1_instance_database.html" target="_self">InstanceDatabase</a></td><td class="desc"></td></tr>
6370
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_1_1_data_1_1_instance_database_interface.html" target="_self">InstanceDatabaseInterface</a></td><td class="desc"></td></tr>
6471
<tr id="row_0_0_3_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_z_1_1_data_1_1_instance_handler.html" target="_self">InstanceHandler</a></td><td class="desc"></td></tr>
6572
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_a_z_1_1_data_1_1_instance_id.html" target="_self">InstanceId</a></td><td class="desc"></td></tr>
6673
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_1_1_scoped_value.html" target="_self">ScopedValue</a></td><td class="desc">Sets a variable upon construction and again when the object goes out of scope </td></tr>
67-
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>AZStd</b></td><td class="desc"></td></tr>
74+
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="dynsection.toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>AZStd</b></td><td class="desc"></td></tr>
6875
<tr id="row_1_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_std_1_1concurrency__check__scope.html" target="_self">concurrency_check_scope</a></td><td class="desc">Simple scope wrapper for concurrency check (so you don't have to manually call soft_lock() and soft_unlock()) </td></tr>
6976
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_std_1_1concurrency__checker.html" target="_self">concurrency_checker</a></td><td class="desc"></td></tr>
7077
<tr id="row_1_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_z_std_1_1fixed__vector__set.html" target="_self">fixed_vector_set</a></td><td class="desc"></td></tr>
@@ -79,7 +86,7 @@
7986
<!-- start footer part -->
8087
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
8188
<ul>
82-
<li class="footer">Generated on Mon Oct 9 2023 13:38:13 for Open 3D Engine AtomCore API Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
89+
<li class="footer">Generated on Mon Dec 2 2024 14:39:37 for Open 3D Engine AtomCore API Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
8390
</ul>
8491
</div>
8592
</body>

‎frameworks/AtomCore/bdwn.png‎

-146 Bytes
Binary file not shown.

‎frameworks/AtomCore/class_a_z_1_1_data_1_1_instance_data-members.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.9.6"/>
6+
<meta name="generator" content="Doxygen 1.12.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Open 3D Engine AtomCore API Reference: Member List</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript">var page_layout=1;</script>
1111
<script type="text/javascript" src="jquery.js"></script>
1212
<script type="text/javascript" src="dynsections.js"></script>
13+
<script type="text/javascript" src="clipboard.js"></script>
1314
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14-
<script type="text/javascript" src="resize.js"></script>
1515
<script type="text/javascript" src="navtreedata.js"></script>
1616
<script type="text/javascript" src="navtree.js"></script>
17+
<script type="text/javascript" src="resize.js"></script>
18+
<script type="text/javascript" src="cookie.js"></script>
1719
<link href="doxygen.css" rel="stylesheet" type="text/css" />
1820
</head>
1921
<body>
@@ -24,7 +26,7 @@
2426
<tbody>
2527
<tr id="projectrow">
2628
<td id="projectalign">
27-
<div id="projectname">Open 3D Engine AtomCore API Reference<span id="projectnumber">&#160;23.10.0</span>
29+
<div id="projectname">Open 3D Engine AtomCore API Reference<span id="projectnumber">&#160;24.09.1</span>
2830
</div>
2931
<div id="projectbrief">O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.</div>
3032
</td>
@@ -33,7 +35,12 @@
3335
</table>
3436
</div>
3537
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.9.6 -->
38+
<!-- Generated by Doxygen 1.12.0 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
41+
$(function() { codefold.init(0); });
42+
/* @license-end */
43+
</script>
3744
</div><!-- top -->
3845
<div id="nav-tree">
3946
<div id="nav-tree-contents">
@@ -46,7 +53,7 @@
4653
</div>
4754
<script type="text/javascript">
4855
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
49-
$(document).ready(function(){initNavTree('class_a_z_1_1_data_1_1_instance_data.html',''); initResizable(); });
56+
$(function(){initNavTree('class_a_z_1_1_data_1_1_instance_data.html',''); initResizable(true); });
5057
/* @license-end */
5158
</script>
5259
<div id="doc-content">
@@ -70,7 +77,7 @@
7077
<!-- start footer part -->
7178
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
7279
<ul>
73-
<li class="footer">Generated on Mon Oct 9 2023 13:38:13 for Open 3D Engine AtomCore API Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
80+
<li class="footer">Generated on Mon Dec 2 2024 14:39:37 for Open 3D Engine AtomCore API Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
7481
</ul>
7582
</div>
7683
</body>

0 commit comments

Comments
 (0)