From 54320f730c6061f404189b7e4da45f6920dbcebc Mon Sep 17 00:00:00 2001 From: baldurk Date: Fri, 15 May 2026 17:10:54 +0100 Subject: [PATCH] Move anchor label above function in docs * The anchor label being inside the cpp:function entry seems to break things in the parameters later --- docs/in_application_api.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/in_application_api.rst b/docs/in_application_api.rst index 4bd8c314c..ff3e44f23 100644 --- a/docs/in_application_api.rst +++ b/docs/in_application_api.rst @@ -13,6 +13,8 @@ The recommended way to access the RenderDoc API is to passively check if the mod To do this you'll use your platforms dynamic library functions to see if the library is open already - e.g. ``GetModuleHandle`` on Windows, or ``dlopen`` with the ``RTLD_NOW | RTLD_NOLOAD`` flags if available on \*nix systems. On most platforms you can just search for the module name - ``renderdoc.dll`` on Windows, or ``librenderdoc.so`` on Linux, or ``libVkLayer_GLES_RenderDoc.so`` on Android should be sufficient here, so you don't need to know the path to where RenderDoc is running from. This will vary by platform however so consult your platform's OS documentation. Then you can use ``GetProcAddress`` or ``dlsym`` to fetch the ``RENDERDOC_GetAPI`` function using the typedef above. +.. _renderdoc-api-example: + .. cpp:function:: int RENDERDOC_GetAPI(RENDERDOC_Version version, void **outAPIPointers) @@ -20,8 +22,6 @@ To do this you'll use your platforms dynamic library functions to see if the lib Note that version numbers follow `semantic versioning `_ which means the implementation returned may have a higher minor and/or patch version than requested. -.. _renderdoc-api-example: - Example code: .. highlight:: c++