> home > Custom Layer Boundary API

view_relative_box_of_pos

January 19th 2020
Compute the box of a character that spans a particular byte position, relative to the top left corner of a given line

Signature

C++
Rect_f32
view_relative_box_of_pos(Application_Links* app,
                         View_ID view_id,
                         i64 base_line,
                         i64 pos);

Parameters

app

the standard custom layer context pointer

view_id

the id of the view who's layout will be measured

base_line

the line number of the line that serves as the relative starting point of the measurement

pos

the absolute byte index of the position to query

Return

the rectangle of a character in the layout that is closest to including the given query position in it's span, with coordinates set relative to the top left corner of the base line, on success, when the view exists and contains the base line and query position, cleared to zero otherwise

Details

Line numbers are 1 based.
Equivalent to calling the buffer related function of the same name by deriving the buffer, width, and face from the view.