diff options
| author | David Shah <dave@ds0.me> | 2020-02-03 11:43:35 +0000 |
|---|---|---|
| committer | David Shah <dave@ds0.me> | 2020-02-03 11:43:35 +0000 |
| commit | 25f57a1e387dd3155cf1dacb14657f000ad02fc8 (patch) | |
| tree | 94a32c341ae0dcca41823678abf813fae57b88f8 /docs | |
| parent | ad1cc12df1aa13c1618d85c07805a4987e0e041f (diff) | |
| download | nextpnr-25f57a1e387dd3155cf1dacb14657f000ad02fc8.tar.gz nextpnr-25f57a1e387dd3155cf1dacb14657f000ad02fc8.tar.bz2 nextpnr-25f57a1e387dd3155cf1dacb14657f000ad02fc8.zip | |
docs: Document getRouteBoundingBox
Signed-off-by: David Shah <dave@ds0.me>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/archapi.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/archapi.md b/docs/archapi.md index 6e59ecdb..c4020fa8 100644 --- a/docs/archapi.md +++ b/docs/archapi.md @@ -237,6 +237,13 @@ 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 + +Get the bounding box required to route an arc, assuming an uncongested +chip. There may be significant performance impacts if routing regularly +exceeds these bounds by more than a small margin; so an over-estimate +of the bounds is almost always better than an under-estimate. + Pip Methods ----------- |