From 25f57a1e387dd3155cf1dacb14657f000ad02fc8 Mon Sep 17 00:00:00 2001 From: David Shah Date: Mon, 3 Feb 2020 11:43:35 +0000 Subject: docs: Document getRouteBoundingBox Signed-off-by: David Shah --- docs/archapi.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs') 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 ----------- -- cgit v1.2.3