> home > Custom Layer Boundary API

view_get_buffer

September 8th 2024
Get the buffer attached to a view

Signature

C++
Buffer_ID
view_get_buffer(Application_Links* app,
                View_ID view_id,
                Access_Flag access);

Parameters

app

the standard custom layer context pointer

view_id

the id of the view to query

access

required access flags for the buffer, in this call the flag Access_Visible indicates whether the view is currently displaying it's buffer, by adding it to the access flags you can require that the buffer is visible

Return

the id of the buffer if the view exists and the buffer satisfies the access requirements, zero otherwise