output-pane-free-cached-display Function

Summary

Frees the cached display in an output pane.

Package

capi

Signature

output-pane-free-cached-display pane => user-info

Arguments

pane⇩

An output-pane.

Values

user-info⇩

A Lisp object.

Description

The function output-pane-free-cached-display frees the last cached display in pane. This is useful because the cached display can be large in memory.

output-pane-free-cached-display returns the user-info that is associated with the cached display. Such user-info can be set either by (setf output-pane-cached-display-user-info) or by passing user-info to start-drawing-with-cached-display.

Notes

1. output-pane-free-cached-display also undoes any effect of start-drawing-with-cached-display.
2. The Cached Display interface functions do not affect the display-callback and it is your responsibility to prevent the display-callback being called. See output-pane-draw-from-cached-display for more information.

Examples

This file illustrates the use of output-pane-free-cached-display in a drag operation:

(example-edit-file "capi/output-panes/cached-display")

See also

output-pane-cache-display
start-drawing-with-cached-display
12.5 Transient display on output-pane and subclasses