Deploy GH

api/latest/class_ogre_1_1_vulkan_render_system.html

@@ -380,6 +380,9 @@
 <tr class="memitem:a40ce71469756b9785566c9a2d00ad01c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#a40ce71469756b9785566c9a2d00ad01c">getPriorityConfigOption</a> (size_t idx) const override</td></tr>
 <tr class="memdesc:a40ce71469756b9785566c9a2d00ad01c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Some options depend on other options.  <a href="class_ogre_1_1_vulkan_render_system.html#a40ce71469756b9785566c9a2d00ad01c">More...</a><br /></td></tr>
 <tr class="separator:a40ce71469756b9785566c9a2d00ad01c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a25435fbf2c14e47d71329ebc60162991"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#a25435fbf2c14e47d71329ebc60162991">getSwappyFramePacing</a> () const</td></tr>
+<tr class="memdesc:a25435fbf2c14e47d71329ebc60162991"><td class="mdescLeft">&#160;</td><td class="mdescRight">ANDROID ONLY: Whether Swappy is enabled. See <a class="el" href="class_ogre_1_1_vulkan_render_system.html#a300e5b9e5f7bfab2d131a04baaed6f4f" title="ANDROID ONLY: Whether to enable/disable Swappy frame pacing.">setSwappyFramePacing()</a>.  <a href="class_ogre_1_1_vulkan_render_system.html#a25435fbf2c14e47d71329ebc60162991">More...</a><br /></td></tr>
+<tr class="separator:a25435fbf2c14e47d71329ebc60162991"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5d861dd78eb95245287e154893ab52d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_ogre.html#aa3a7b6dfb905e6572d62f0dfa3d4274d">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#a5d861dd78eb95245287e154893ab52d6">getVerticalTexelOffset</a> () override</td></tr>
 <tr class="memdesc:a5d861dd78eb95245287e154893ab52d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.  <a href="class_ogre_1_1_vulkan_render_system.html#a5d861dd78eb95245287e154893ab52d6">More...</a><br /></td></tr>
 <tr class="separator:a5d861dd78eb95245287e154893ab52d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -437,6 +440,9 @@
 <tr class="memitem:a09ef8ec23ef96f72756915dbbf79e381"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#a09ef8ec23ef96f72756915dbbf79e381">setStencilBufferParams</a> (<a class="el" href="namespace_ogre.html#a5a7c15d68e8c7d585c410bc5a93682f4">uint32</a> refValue, const <a class="el" href="struct_ogre_1_1_stencil_params.html">StencilParams</a> &amp;stencilParams) override</td></tr>
 <tr class="memdesc:a09ef8ec23ef96f72756915dbbf79e381"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method allows you to set all the stencil buffer parameters in one call.  <a href="class_ogre_1_1_vulkan_render_system.html#a09ef8ec23ef96f72756915dbbf79e381">More...</a><br /></td></tr>
 <tr class="separator:a09ef8ec23ef96f72756915dbbf79e381"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a300e5b9e5f7bfab2d131a04baaed6f4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#a300e5b9e5f7bfab2d131a04baaed6f4f">setSwappyFramePacing</a> (bool bEnable, <a class="el" href="class_ogre_1_1_window.html">Window</a> *callingWindow=0)</td></tr>
+<tr class="memdesc:a300e5b9e5f7bfab2d131a04baaed6f4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">ANDROID ONLY: Whether to enable/disable Swappy frame pacing.  <a href="class_ogre_1_1_vulkan_render_system.html#a300e5b9e5f7bfab2d131a04baaed6f4f">More...</a><br /></td></tr>
+<tr class="separator:a300e5b9e5f7bfab2d131a04baaed6f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:acf4ba4fa8ff3b5387cd18f617538516f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#acf4ba4fa8ff3b5387cd18f617538516f">sharedVkInitialization</a> ()</td></tr>
 <tr class="separator:acf4ba4fa8ff3b5387cd18f617538516f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2c7caf82ac2d6d9ddb335f0ee0effb10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_vulkan_render_system.html#a2c7caf82ac2d6d9ddb335f0ee0effb10">shutdown</a> () override</td></tr>
@@ -4456,6 +4462,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#a40ce71469756b9785566c9a2
 
 <p>Reimplemented from <a class="el" href="class_ogre_1_1_render_system.html#ac4261b30115ea67beb7fc8dc87c8bce5">Ogre::RenderSystem</a>.</p>
 
+</div>
+</div>
+<a id="a25435fbf2c14e47d71329ebc60162991"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a25435fbf2c14e47d71329ebc60162991">&#9670;&nbsp;</a></span>getSwappyFramePacing()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Ogre::VulkanRenderSystem::getSwappyFramePacing </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>ANDROID ONLY: Whether Swappy is enabled. See <a class="el" href="class_ogre_1_1_vulkan_render_system.html#a300e5b9e5f7bfab2d131a04baaed6f4f" title="ANDROID ONLY: Whether to enable/disable Swappy frame pacing.">setSwappyFramePacing()</a>. </p>
+
 </div>
 </div>
 <a id="a5d861dd78eb95245287e154893ab52d6"></a>
@@ -5117,6 +5142,45 @@ <h2 class="memtitle"><span class="permalink"><a href="#a09ef8ec23ef96f72756915db
 
 <p>Reimplemented from <a class="el" href="class_ogre_1_1_render_system.html#a62c4d393915276eb56752890a0029f92">Ogre::RenderSystem</a>.</p>
 
+</div>
+</div>
+<a id="a300e5b9e5f7bfab2d131a04baaed6f4f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a300e5b9e5f7bfab2d131a04baaed6f4f">&#9670;&nbsp;</a></span>setSwappyFramePacing()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Ogre::VulkanRenderSystem::setSwappyFramePacing </td>
+          <td>(</td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>bEnable</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="class_ogre_1_1_window.html">Window</a> *&#160;</td>
+          <td class="paramname"><em>callingWindow</em> = <code>0</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>ANDROID ONLY: Whether to enable/disable Swappy frame pacing. </p>
+<p>It may be disabled by OgreNext if Swappy is causing bugs on the current device.</p>
+<p>Users can cache the value of <a class="el" href="class_ogre_1_1_vulkan_render_system.html#a25435fbf2c14e47d71329ebc60162991" title="ANDROID ONLY: Whether Swappy is enabled. See setSwappyFramePacing().">getSwappyFramePacing()</a> on shutdown to force-disable on the next run.</p>
+<p>This call is ignored in other platforms. </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">bEnable</td><td>Whether to enable or disable. </td></tr>
+    <tr><td class="paramname">callingWindow</td><td>For internal use. Leave this set as nullptr. </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a id="acf4ba4fa8ff3b5387cd18f617538516f"></a>

api/latest/functions_c.html

@@ -874,14 +874,14 @@ <h3><a id="index_c"></a>- c -</h3><ul>
 : <a class="el" href="struct_ogre_1_1_hlms_base_prop.html#a3400aace76177d8ce24cc11eb8ef1680">Ogre::HlmsBaseProp</a>
 </li>
 <li>colour()
-: <a class="el" href="class_ogre_1_1_manual_object.html#a064c6607c20afab70773abd598de12ff">Ogre::ManualObject</a>
+: <a class="el" href="class_ogre_1_1_manual_object.html#acd8acf53176b680b06c61a7e947cbf3f">Ogre::ManualObject</a>
 </li>
 <li>Colour
 : <a class="el" href="class_ogre_1_1_render_pass_descriptor.html#ae003dc630410b352f3e14668b7938254a0cc6e5e862027a924aece253df107fa7">Ogre::RenderPassDescriptor</a>
 </li>
 <li>colour
 : <a class="el" href="class_ogre_1_1v1_1_1_billboard_chain_1_1_element.html#a6d8fd40f0e4fa74963e628d6b152654c">Ogre::v1::BillboardChain::Element</a>
-, <a class="el" href="class_ogre_1_1v1_1_1_manual_object.html#aec35d093b8cc51d9c1edf74b0bf6155b">Ogre::v1::ManualObject</a>
+, <a class="el" href="class_ogre_1_1v1_1_1_manual_object.html#a0b78d55494b11f535c513fd8cc64b5da">Ogre::v1::ManualObject</a>
 </li>
 <li>Colour0
 : <a class="el" href="class_ogre_1_1_render_pass_descriptor.html#ae003dc630410b352f3e14668b7938254ac6494c572533b8d986293e55386a9e1c">Ogre::RenderPassDescriptor</a>

api/latest/functions_d.html

@@ -460,7 +460,7 @@ <h3><a id="index_d"></a>- d -</h3><ul>
 : <a class="el" href="class_ogre_1_1_animable_value.html#adccd62bb2b72c602b9c59ca651256d69a67875f169fb2deebc7c3590efbe621f1">Ogre::AnimableValue</a>
 </li>
 <li>Degree()
-: <a class="el" href="class_ogre_1_1_degree.html#aa8919fdf01749e0e692842be2a7c4a8e">Ogre::Degree</a>
+: <a class="el" href="class_ogre_1_1_degree.html#a38f343d7b34d2239c9c5ec7270639b86">Ogre::Degree</a>
 </li>
 <li>DegreesToAngleUnits()
 : <a class="el" href="class_ogre_1_1_math.html#a9d7c5024ffb068064eb5194b9484aa87">Ogre::Math</a>

api/latest/functions_f.html

@@ -144,7 +144,7 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 : <a class="el" href="class_ogre_1_1_render_queue.html#ad2b57c9b40e33d4b64f613a5a6147367afaf209c76453b55e28708a165b37386e">Ogre::RenderQueue</a>
 </li>
 <li>FastArray()
-: <a class="el" href="class_ogre_1_1_fast_array.html#a76046cedb6e63996bdfc24fc61d3573e">Ogre::FastArray&lt; T &gt;</a>
+: <a class="el" href="class_ogre_1_1_fast_array.html#a89b74d42aeff0f51b9bc5db006ae57ce">Ogre::FastArray&lt; T &gt;</a>
 </li>
 <li>fastForward()
 : <a class="el" href="class_ogre_1_1_particle_system.html#ac324ff4b3487f547ca774176de9c2e0b">Ogre::ParticleSystem</a>
@@ -186,7 +186,7 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 : <a class="el" href="class_ogre_1_1_file_not_found_exception.html#ac5774daad7866a3b538731c16ba08faf">Ogre::FileNotFoundException</a>
 </li>
 <li>FileStreamDataStream()
-: <a class="el" href="class_ogre_1_1_file_stream_data_stream.html#a5df1c318c09bdd986a5a5a3d42f16b93">Ogre::FileStreamDataStream</a>
+: <a class="el" href="class_ogre_1_1_file_stream_data_stream.html#a17da6f498bcd96c82e6e9d899d5a6c45">Ogre::FileStreamDataStream</a>
 </li>
 <li>FileSystemArchive()
 : <a class="el" href="class_ogre_1_1_file_system_archive.html#ad5ae519a6d13d89a7d4dc66ea8f64875">Ogre::FileSystemArchive</a>
@@ -496,7 +496,7 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 : <a class="el" href="struct_ogre_1_1_lw_string_1_1_float.html#a4d2b51c6b067dbf24f881a184279f88f">Ogre::LwString::Float</a>
 </li>
 <li>float2()
-: <a class="el" href="struct_ogre_1_1float2.html#acc1f836dc566a17404141826fa187759">Ogre::float2</a>
+: <a class="el" href="struct_ogre_1_1float2.html#aea83a5eb65db2157b55e3df390d4b8de">Ogre::float2</a>
 </li>
 <li>float4()
 : <a class="el" href="struct_ogre_1_1float4.html#a4e18ae6fc1a9b1313e30b8946d92b2dd">Ogre::float4</a>
@@ -665,7 +665,7 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 : <a class="el" href="class_ogre_1_1_vulkan_delayed__vk_destroy_framebuffer.html#adfc0f32108ff444ffe7f36d636e6f152">Ogre::VulkanDelayed_vkDestroyFramebuffer</a>
 </li>
 <li>FrameBufferDescKey()
-: <a class="el" href="struct_ogre_1_1_frame_buffer_desc_key.html#a65184d4642828ad08f5eb6f78b28408a">Ogre::FrameBufferDescKey</a>
+: <a class="el" href="struct_ogre_1_1_frame_buffer_desc_key.html#a21e634298bfc5da7a8ff414cb87fd4f9">Ogre::FrameBufferDescKey</a>
 </li>
 <li>frameEnd()
 : <a class="el" href="class_ogre_1_1_page.html#ac66750b1af3b6ff9a9109540a50bd2f0">Ogre::Page</a>
@@ -815,7 +815,7 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 <li>front
 : <a class="el" href="struct_ogre_1_1_box.html#a5e545a9bd1bc4151a113267c6529d84f">Ogre::Box</a>
 , <a class="el" href="class_ogre_1_1_fast_array.html#a6d1530273d55eefc98400b8281bd72bc">Ogre::FastArray&lt; T &gt;</a>
-, <a class="el" href="class_ogre_1_1_hashed_vector.html#ac527f3aa4ac341a45abc720cd457f021">Ogre::HashedVector&lt; T &gt;</a>
+, <a class="el" href="class_ogre_1_1_hashed_vector.html#ae58c9b49af378fbedd6c717369435135">Ogre::HashedVector&lt; T &gt;</a>
 , <a class="el" href="class_ogre_1_1_small_vector_template_common.html#aabbc326f17698c1b404fcfed47099f19">Ogre::SmallVectorTemplateCommon&lt; T &gt;</a>
 , <a class="el" href="class_ogre_1_1_stack_vector.html#a03a99b2e85e08d00b30ebf8c73878e61">Ogre::StackVector&lt; T, Capacity &gt;</a>
 </li>

api/latest/functions_func_g.html

@@ -143,13 +143,13 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 <li>get()
 : <a class="el" href="class_ogre_1_1_d3_d11_device.html#a83da8ed3c0a317cba16b949d4e2392d2">Ogre::D3D11Device</a>
 , <a class="el" href="class_ogre_1_1_d3_d11_device_resource_manager.html#ad946745d946e617658dcbe28df7cdda8">Ogre::D3D11DeviceResourceManager</a>
-, <a class="el" href="class_ogre_1_1_d3_d11_mappings.html#a9ce743951b99e5e5b9cd87c26c9ea8dd">Ogre::D3D11Mappings</a>
+, <a class="el" href="class_ogre_1_1_d3_d11_mappings.html#a6973fae3ecdddd729fc70ab3b5682c8a">Ogre::D3D11Mappings</a>
 , <a class="el" href="class_ogre_1_1_g_l3_plus_mappings.html#a01f4e232f1b8a524701dd94c072b7049">Ogre::GL3PlusMappings</a>
 , <a class="el" href="class_ogre_1_1_metal_mappings.html#a85fd33bfd63563d19b28d714127ffa74">Ogre::MetalMappings</a>
 , <a class="el" href="class_ogre_1_1_property.html#a3580aea5f32b075c0ec343fe9862ce75">Ogre::Property&lt; T &gt;</a>
 , <a class="el" href="class_ogre_1_1_raw_simd_unique_ptr.html#adfd69f6b9163e64d24874e4fba195315">Ogre::RawSimdUniquePtr&lt; T, M_CATEGORY &gt;</a>
 , <a class="el" href="class_ogre_1_1_thread_local_ptr.html#a721c35613c21c0be0fad744e4cd921b1">Ogre::ThreadLocalPtr&lt; T &gt;</a>
-, <a class="el" href="class_ogre_1_1_vulkan_mappings.html#a4404831b8dbed2b7187d507a54710c7c">Ogre::VulkanMappings</a>
+, <a class="el" href="class_ogre_1_1_vulkan_mappings.html#a8ae87e7e099f26cfee74df2b09b25a9f">Ogre::VulkanMappings</a>
 </li>
 <li>get2DElementsIterator()
 : <a class="el" href="class_ogre_1_1v1_1_1_overlay.html#a7c9d2d1febc3eae313e1a11c343292bd">Ogre::v1::Overlay</a>
@@ -5320,7 +5320,7 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 : <a class="el" href="class_ogre_1_1_scene_manager.html#aa6008c82cd40e85f1b1c38d7929ec2ba">Ogre::SceneManager</a>
 </li>
 <li>getSide()
-: <a class="el" href="class_ogre_1_1_plane.html#a115540f9bb7a88c0f22dcbc0ca087a68">Ogre::Plane</a>
+: <a class="el" href="class_ogre_1_1_plane.html#a519225d752a20f3459d2f0cc20346468">Ogre::Plane</a>
 </li>
 <li>getSimulationTickRate()
 : <a class="el" href="class_ogre_1_1_particle_system_manager.html#a35d266a48065e568d23743cd9c4d487d">Ogre::ParticleSystemManager</a>
@@ -5742,6 +5742,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 <li>getSwapchainImage()
 : <a class="el" href="class_ogre_1_1_vulkan_window_swap_chain_based.html#a3766e755970279f575ec9e80db978b2d">Ogre::VulkanWindowSwapChainBased</a>
 </li>
+<li>getSwappyFramePacing()
+: <a class="el" href="class_ogre_1_1_vulkan_render_system.html#a25435fbf2c14e47d71329ebc60162991">Ogre::VulkanRenderSystem</a>
+</li>
 <li>getSwBufferPtr()
 : <a class="el" href="class_ogre_1_1_indirect_buffer_packed.html#a7df6a2dc0f4dd66f5c8b122258c3dd9b">Ogre::IndirectBufferPacked</a>
 </li>

api/latest/functions_func_s.html

@@ -2670,6 +2670,9 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 <li>setSupported()
 : <a class="el" href="class_ogre_1_1_vulkan_support.html#abce0d5d7a77ce2824d5186dfe303d976">Ogre::VulkanSupport</a>
 </li>
+<li>setSwappyFramePacing()
+: <a class="el" href="class_ogre_1_1_vulkan_render_system.html#a300e5b9e5f7bfab2d131a04baaed6f4f">Ogre::VulkanRenderSystem</a>
+</li>
 <li>setSyntaxCode()
 : <a class="el" href="class_ogre_1_1_gpu_program.html#a48901c745f712840d8ff24cd04e50678">Ogre::GpuProgram</a>
 </li>
@@ -3002,7 +3005,7 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 : <a class="el" href="class_ogre_1_1v1_1_1_panel_overlay_element.html#af59d2b59dd76057f31e19cde6456c176">Ogre::v1::PanelOverlayElement</a>
 </li>
 <li>setValue()
-: <a class="el" href="class_ogre_1_1_animable_value.html#ac9f25ae01ac3b9cec80df9e7e930bac9">Ogre::AnimableValue</a>
+: <a class="el" href="class_ogre_1_1_animable_value.html#a7bf19d59335bc397010e009eaf593288">Ogre::AnimableValue</a>
 , <a class="el" href="class_ogre_1_1bitset64.html#a9ac806c945156cea08091858d2d5a83a">Ogre::bitset64</a>
 , <a class="el" href="class_ogre_1_1cbitset_n.html#a5df41b65723a789e579d2b6260e5f6e0">Ogre::cbitsetN&lt; _N, _internalDataType, _bits, _mask &gt;</a>
 , <a class="el" href="class_ogre_1_1_controller_value.html#ab719e69a47857662b71041b9c74e546b">Ogre::ControllerValue&lt; T &gt;</a>
@@ -3383,7 +3386,7 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 </li>
 <li>SmallVector()
 : <a class="el" href="class_ogre_1_1_small_vector.html#a69a8914af56f637bad1092975e2ca1ee">Ogre::SmallVector&lt; T, N &gt;</a>
-, <a class="el" href="class_ogre_1_1_small_vector_3_01_t_00_010_01_4.html#aa2c2ab13bd5bfeb4fd1048ac62b0d46a">Ogre::SmallVector&lt; T, 0 &gt;</a>
+, <a class="el" href="class_ogre_1_1_small_vector_3_01_t_00_010_01_4.html#acde38b560a786b47c3a89f4b8d820d9c">Ogre::SmallVector&lt; T, 0 &gt;</a>
 </li>
 <li>SmallVectorImpl()
 : <a class="el" href="class_ogre_1_1_small_vector_impl.html#af8af78d33f9c946183a925698f36c6ad">Ogre::SmallVectorImpl&lt; T &gt;</a>