> home > Custom Layer Boundary API

view_relative_character_from_pos

September 8th 2024
Compute a character index relative to a particular lines first character

Signature

C++
i64
view_relative_character_from_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 relative index, based at the first character of the base line, of the character that is closest to spanning the query position on success, when the view exists and contains the base line and query position, 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.