NAME

SYNOPSIS

DESCRIPTION

The possible values for the optional flags field are (combine with bit.bor):

TD_HINT_IGNORE - no change to the flag state from last time. TD_HINT_CONTINUED - resize events are likely to be followed with more, TD_HINT_UNFOCUSED - no input focus, input events can still arrive but no visibile indication (e.g. cursor) needs to be shown TD_HINT_INVISIBLE - not currently visible/used, no need to update/draw TD_HINT_MAXIMIZED - window is in a 'maximized' state, some UI toolkits will change their visible behavior if they know that they are in this state. TD_HINT_FULLSCREEN - window is in a 'fullscreen' state, similar to the maximized state, some UI toolkits may want this. TD_HINT_DETACHED - (with provided embedded proxy), the associated window has been detached from the embedding and should not be considered in local layouting.

If the optional disptbl is set and is a table, the fields 'ppcm' and 'subpixel_layout' are expected to be present.

If the * WORLDID * form is used, the current default output display properties will be sent.

The function returns the current estimated cell dimensions for clients that use the tpack- format for server-side text. This is affected by the last fonthint as well as the provided density, and is just an estimate.

NOTES

1

width/height that exceeds the static compile-time limitations of

MAX_TARGETW or MAX_TARGETH will be clamped to those values. Invalid hint- dimensions (0 <= n) is a terminal state transition.

2

changing the pixel density (width/height + disptbl with phy_width, phy_height) may incur font rendering changes in the dst referenced target.

3

The correlated event gets special treatment. When the dequeue function in the shared memory interface discover a displayhint event, the remainder of the queue will be scanned for additional ones. Relevant fields will be merged and properties that are in conflict will favor the most recent. This prevents bubbles from a possible resize- reaction for common scenarios such as drag-resizing a window.

EXAMPLE

function target_displayhint0()
      local a = target_alloc("example", function() end);
      show_image(a);
      resize_image(a, VRESW, VRESH);
      target_displayhint(a, VRESW, VRESH);
end

SEE ALSO: