Unit 'intuition' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#amunits]

GetScreenDrawInfo

Get pointer to rendering information.

Declaration

Source position: intuition.pas line 4114

function GetScreenDrawInfo(

  screen: pScreen

):pDrawInfo;

Arguments

screen

  

A pointer to a valid, open screen.

Function result

A pointer to a system-allocated DrawInfo structure.

Description

Returns a pointer to a TDrawInfo structure derived from the screen passed. This data structure is Read Only. The field dri_Version identifies which version of TDrawInfo you are given a pointer to.

Note:

Some information in the TDrawInfo structure may in the future be calculated the first time this function is called for a particular screen.

You must call FreeScreenDrawInfo() when you are done using the returned pointer.

This function does not prevent a screen from closing. Apply it only to the screens you opened yourself, or apply a protocol such as LockPubScreen().

WARNING: Until further notice, the pointer returned does not remain valid after the screen is closed.

This function and FreeScreenDrawInfo() don't really do much now, but they provide an upward compatibility path. That means that if you misuse them today, they probably won't cause a problem, although they may someday later. So, please be very careful only to use the TDrawInfo structure between calls to GetScreenDrawInfo() and FreeScreenDrawInfo(), and be sure that you don't forget FreeScreenDrawInfo().

See also

LockPubScreen

  

Prevent a public screen from closing.

FreeScreenDrawInfo

  

Finish using a DrawInfo structure.


Documentation generated on: 2021-07-30