aboutsummaryrefslogtreecommitdiffstats
path: root/docs/archapi.md
diff options
context:
space:
mode:
authormyrtle <gatecat@ds0.me>2022-12-07 10:26:17 +0100
committerGitHub <noreply@github.com>2022-12-07 10:26:17 +0100
commit519011533a3b7582b984226536cb424d462d1599 (patch)
tree31ee37d2c50481ab5f5a5bec2b07ac46d7d7d9ca /docs/archapi.md
parenta342b96bb0d4370d3e575a0189da2273b94ea765 (diff)
parentd1afd6c0f1f8452d7461bbf33c84dbfd59236d03 (diff)
downloadnextpnr-519011533a3b7582b984226536cb424d462d1599.tar.gz
nextpnr-519011533a3b7582b984226536cb424d462d1599.tar.bz2
nextpnr-519011533a3b7582b984226536cb424d462d1599.zip
Merge pull request #1058 from YosysHQ/gatecat/bounds-refactor
refactor: rename ArcBounds -> BoundingBox and use this in HeAP
Diffstat (limited to 'docs/archapi.md')
-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.