aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorgatecat <gatecat@ds0.me>2022-12-07 10:00:53 +0100
committergatecat <gatecat@ds0.me>2022-12-07 10:00:53 +0100
commite260ac33abdd175f38ea5d8367c52a154b486648 (patch)
tree56ca8a3877a1270bcac51160067e1016abcb97cf /docs
parentcd3b76e3f7ce9d9927087f6fdd38e04968688ee7 (diff)
downloadnextpnr-e260ac33abdd175f38ea5d8367c52a154b486648.tar.gz
nextpnr-e260ac33abdd175f38ea5d8367c52a154b486648.tar.bz2
nextpnr-e260ac33abdd175f38ea5d8367c52a154b486648.zip
refactor: ArcBounds -> BoundingBox
Signed-off-by: gatecat <gatecat@ds0.me>
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index efd833d2..39b2a6a9 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -333,7 +333,7 @@ Get a list of all wires on the device.
Get a list of all bel pins attached to a given wire.
-### ArcBounds getRouteBoundingBox(WireId src, WireId dst) const
+### BoundingBox getRouteBoundingBox(WireId src, WireId dst) const
Get the bounding box required to route an arc, assuming an uncongested
chip. There may be significant performance impacts if routing regularly
@@ -732,7 +732,7 @@ Cluster Methods
Gets the root cell of a cluster, which is used as a datum point when placing the cluster.
-### ArcBounds getClusterBounds(ClusterId cluster) const
+### BoundingBox getClusterBounds(ClusterId cluster) const
Gets an approximate bounding box of the cluster. This is intended for area allocation in the placer and is permitted to occasionally give incorrect estimates, for example due to irregularities in the fabric depending on cluster placement. `getClusterPlacement` should always be used to get exact locations.