Use cuda syntax highlighting and label tabs as CUDA C++

Except where Raw strings are used, which pygments CUDA highlighter does not appear to support

Author: ptheywood

src/guide/2-model-definition/1-model.rst

@@ -15,7 +15,7 @@ A ``ModelDescription`` is initialised with a name:
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create a ModelDescription object called model, initialised with the name "some_model"
     flamegpu::ModelDescription model("some_model");

src/guide/2-model-definition/2-environment.rst

@@ -15,7 +15,7 @@ An ``EnvironmentDescription`` is initialised as shown below:
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create an EnvironmentDescription object called env
     flamegpu::EnvironmentDescription env;
@@ -48,7 +48,7 @@ Any arithmetic or enum type can be used as an environment property
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Define environmental properties and their initial values
     env.add<float>("f_prop", 12.0f);        // Create float property 'f_prop', with value of 12
@@ -70,7 +70,7 @@ An environment can be associated with a particular model using the ``setEnvironm
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Attach the EnvironmentDescription to a ModelDescription
     model.setEnvironment(env);
@@ -85,7 +85,7 @@ Full Example Code From This Page
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create an EnvironmentDescription object called env
     flamegpu::EnvironmentDescription env;

src/guide/2-model-definition/3-agent.rst

@@ -11,7 +11,7 @@ FLAMEGPU2 agents are associated with a particular model. As such they are create
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create a new agent called 'predator' associated the model 'model' 
     flamegpu::AgentDescription &predator = model.newAgent("predator");
@@ -41,7 +41,7 @@ User Defined Variables
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create two new floating point variables, x and y
     predator.newVariable<float>("x");
@@ -67,7 +67,7 @@ Array variables can also be defined by providing a name and array length:
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create an array variable called exampleArray which is an array of 3 integers
     predator.newVariableArray<int>("exampleArray", 3);
@@ -87,7 +87,7 @@ All newly defined agent types will have a default state, but you can add additio
 .. tabs::
 
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create two new states, resting and hunting
     predator.newState("resting");
@@ -105,7 +105,7 @@ Full Example Code From This Page
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Create a new agent called 'predator' associated the model 'model' 
     flamegpu::AgentDescription &predator = model.newAgent("predator");

src/guide/3-behaviour-definition/1-defining-agent-functions.rst

@@ -27,7 +27,7 @@ For Non-RTC functions, when using the C++ interface, the ``FLAMEGPU_AGENT_FUNCTI
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Define an agent function called agent_fn1 - specified ahead of main function
     FLAMEGPU_AGENT_FUNCTION(agent_fn1, flamegpu::MessageNone, flamegpu::MessageNone) {
@@ -45,9 +45,10 @@ For Non-RTC functions, when using the C++ interface, the ``FLAMEGPU_AGENT_FUNCTI
 
 When using the Run-Time Compiled (RTC) functions, optionally in the C++ interface or required by the Python interface, the function must be defined in a string and associated with the AgentDescription using the ``newRTCFunction`` method.
 
+.. cpp syntax highlighting due to issues with the cuda highlighter and raw strings.
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cpp CUDA C++
 
     const char* agent_fn1_source = R"###(
     // Define an agent function called agent_fn1 - specified ahead of main function
@@ -89,7 +90,7 @@ If you wish to define regular functions which can be used within agent function
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Define a function for adding two integers which can be called inside agent functions.
     FLAMEGPU_DEVICE_FUNCTION int add(int a, int b) {
@@ -103,7 +104,7 @@ If you wish to define regular functions which can be used within agent function
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     // Define a function for subtracting two integers which can be called inside agent functions, or in host code
     FLAMEGPU_HOST_DEVICE_FUNCTION int subtract(int a, int b) {
@@ -113,9 +114,10 @@ If you wish to define regular functions which can be used within agent function
 Full Example Code From This Page
 --------------------------------
 
+.. cpp syntax highlighting due to issues with the cuda highlighter and raw strings.
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cpp CUDA C++
 
     // Define a function for adding two integers which can be called inside agent functions.
     FLAMEGPU_DEVICE_FUNCTION int add(int a, int b) {

src/guide/3-behaviour-definition/2-modifying-agent-variables.rst

@@ -13,7 +13,7 @@ To achieve the high performance of FLAMEGPU2, agent behaviours must be implement
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     FLAMEGPU_AGENT_FUNCTION(ExampleFn, flamegpu::MessageNone, flamegpu::MessageNone) {
         // Get the value of agent variable 'x' and store it in local variable 'x'
@@ -34,7 +34,7 @@ in a single function call, during agent functions, elements must be accessed ind
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     FLAMEGPU_AGENT_FUNCTION(ExampleFn, flamegpu::MessageNone, flamegpu::MessageNone) {
         // Return agent variable 'location[1]' and store it in local variable 'y'

src/guide/3-behaviour-definition/3-interacting-with-environment.rst

@@ -8,7 +8,7 @@ Environmental properties are accessed as follows:
 
 .. tabs::
 
-  .. code-tab:: cpp
+  .. code-tab:: cuda CUDA C++
 
     FLAMEGPU_AGENT_FUNCTION(ExampleFn, flamegpu::MessageNone, flamegpu::MessageNone) {
         // Get the value of environment variable 'interaction_radius' and store it in local variable 'interaction_radius'

src/guide/3-behaviour-definition/4-agent-communication.rst

@@ -26,7 +26,7 @@ A new message type can defined using one of the above symbols:
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Create a new message type called "location" which uses the brute force communication strategy
       flamegpu::MessageBruteForce::Description &locationMessage = model.newMessage("location");
@@ -42,7 +42,7 @@ Data the message should contain can then be defined using the ``newVariable`` me
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Add a variable of type "int" with name "id" to the "location_message" type
       locationMessage.newVariable<int>("id");
@@ -60,7 +60,7 @@ and must match that of the message type:
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "outputdata" which has no input messages and outputs a message using the "MessageBruteForce" communication strategy
       FLAMEGPU_AGENT_FUNCTION(outputdata, flamegpu::MessageNone, flamegpu::MessageBruteForce) {
@@ -71,7 +71,7 @@ and must match that of the message type:
 To specify the type of message the function should output, the ``setMessageOutput`` method of the ``AgentFunctionDescription`` object is used:
 
 .. tabs::
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Specify that the "outputdata" agent function outputs a "location_message"
       outputdata.setMessageOutput("location_message");    
@@ -85,7 +85,7 @@ The agent function will now output a message of type "location_message". The var
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "outputdata" which has no input messages and outputs a message using the "MessageBruteForce" communication strategy
       FLAMEGPU_AGENT_FUNCTION(outputdata, flamegpu::MessageNone, flamegpu::MessageBruteForce) {
@@ -99,7 +99,7 @@ If you are using ``MessageSpatial2D`` or ``MessageSpatial3D`` then your message
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "outputdata" which has no input messages and outputs a message using the "MessageSpatial3D" communication strategy
       FLAMEGPU_AGENT_FUNCTION(outputdata, flamegpu::MessageNone, flamegpu::MessageSpatial3D) {
@@ -114,7 +114,7 @@ You must also specify the interaction radius via the ``MessageDescription`` obje
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Specify that the "outputdata" agent function has an interaction radius of 2.0f
       outputdata.setMessageOutput(2.0f);
@@ -130,7 +130,7 @@ If you are using ``MessageArray1D``, ``MessageArray2D`` or ``MessageArray3D`` th
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "outputdata" which has no input messages and outputs a message using the "MessageArray3D" communication strategy
       FLAMEGPU_AGENT_FUNCTION(outputdata, flamegpu::MessageNone, flamegpu::MessageArray3D) {
@@ -148,7 +148,7 @@ Reading a message is very similar to sending one. The second argument in the age
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "inputdata" which has accepts an input message using the "MessageBruteForce" communication strategy and inputs no messages
       FLAMEGPU_AGENT_FUNCTION(inputdata, flamegpu::MessageBruteForce, flamegpu::MessageNone) {
@@ -161,7 +161,7 @@ The input message type is specified using the ``setMessageInput`` method of the
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Specify that the "inputdata" agent function inputs a "location_message"
       inputdata.setMessageInput("location_message");
@@ -176,7 +176,7 @@ With the input message type specified, the message list will be available in the
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "inputdata" which has accepts an input message using the "MessageBruteForce" communication strategy and inputs no messages
       FLAMEGPU_AGENT_FUNCTION(inputdata, flamegpu::MessageBruteForce, flamegpu::MessageNone) {
@@ -193,7 +193,7 @@ Spatial messaging will return all messages within the radius specified at the mo
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "inputdata" which has accepts an input message using the "MessageSpatial3D" communication strategy and inputs no messages
       FLAMEGPU_AGENT_FUNCTION(inputdata, flamegpu::MessageSpatial3D, flamegpu::MessageNone) {
@@ -230,7 +230,7 @@ Messages can be accessed from a specific array index:
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "inputdata" which has accepts an input message using the "MessageSpatial3D" communication strategy and inputs no messages
       FLAMEGPU_AGENT_FUNCTION(inputdata, flamegpu::MessageArray3D, flamegpu::MessageNone) {
@@ -249,7 +249,7 @@ Similar to spatial messaging, array messages can be used to iterate the exclusiv
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "inputdata" which has accepts an input message using the "MessageSpatial3D" communication strategy and inputs no messages
       FLAMEGPU_AGENT_FUNCTION(inputdata, flamegpu::MessageArray3D, flamegpu::MessageNone) {
@@ -271,7 +271,7 @@ If wrapping of array bounds is required, then an alternate iterator method ``wra
 
 .. tabs::
 
-    .. code-tab:: cpp
+    .. code-tab:: cuda CUDA C++
 
       // Define an agent function, "inputdata" which has accepts an input message using the "MessageSpatial3D" communication strategy and inputs no messages
       FLAMEGPU_AGENT_FUNCTION(inputdata, flamegpu::MessageArray3D, flamegpu::MessageNone) {