Skip to content

Commit 77e40ae

Browse files
committed
Birth cross ref, missed flamegpu:: prefix in inline code block
1 parent 513ba3d commit 77e40ae

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

src/guide/3-behaviour-definition/6-host-functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ Agent populations can also be sorted according to a variable, the C++ API can ad
264264
sheep.sortFloat("health", flamegpu.ASC);
265265

266266

267-
It's also possible to create new agents with the ``HostAgentAPI``, this is covered in `Section 6.2. <../6-agent-birth-death/2-agent-birth-host.html>`_. These agents are not created until after the layer has completed execution, so they will not affect reductions or sorts carried out in the same host function. This is the preferred method of host agent birth as it performs a single host-device memory copy.
267+
It's also possible to create new agents with the ``HostAgentAPI``, this is covered in :ref:`Agent Birth from Host Functions`. These agents are not created until after the layer has completed execution, so they will not affect reductions or sorts carried out in the same host function. This is the preferred method of host agent birth as it performs a single host-device memory copy.
268268

269269
For raw access to agent data, ``DeviceAgentVector`` can be used. This has an interface similar to ``AgentVector``, however automatically synchronises data movement between host and device. This should only be used in limited circumstances as copying memory between host and device has high latency.
270270

src/guide/6-agent-birth-death/1-agent-birth-device.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Agent Creation Overview
55
-----------------------
66
The agent creation interface usable in agent functions is only able to create a single agent per existing agent per iteration.
77
Additionally, the agent type and state being created must be earlier specified as part of the model description. If you need
8-
to create more than one agent for each existing agent, you should use the *TODO: link to host agent creation api*
8+
to create more than one agent for each existing agent, you should use the :ref:`Agent Birth from Host Functions`.
99

1010
**Note:** *Agents created by agent functions do not exist until the next layer.*
1111

src/guide/6-agent-birth-death/2-agent-birth-host.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Agent Birth from Host Functions:
2+
13
Agent Birth from Host Functions
24
===============================
35

src/guide/6-agent-birth-death/3-agent-death.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ the ``AgentFunctionDescription`` object:
2323
Agent Death
2424
-----------
2525

26-
To have an agent die, simply ``return DEAD;`` instead of ``return ALIVE;`` at the end of a death-enabled agent function. You can use
26+
To have an agent die, simply ``return flamegpu::DEAD;`` instead of ``return flamegpu::ALIVE;`` at the end of a death-enabled agent function. You can use
2727
conditionals to only have agents die according to a certain condition:
2828

2929
.. tabs::

0 commit comments

Comments
 (0)