From 30537212377d540dee517312398d6ce72211a771 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 4 Apr 2014 14:15:11 +0200 Subject: document multi-display support on list_screens, get_current_icc and get_current_icc_raw MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- info/blueshift.texinfo | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) (limited to 'info') diff --git a/info/blueshift.texinfo b/info/blueshift.texinfo index 27c9dd8..0d9fa35 100644 --- a/info/blueshift.texinfo +++ b/info/blueshift.texinfo @@ -798,6 +798,7 @@ Parse raw (series of bytes) ICC profile data into a function that applies the profile when invoked. @item get_current_icc_raw() +@itemx get_current_icc_raw(display) Load the raw data for the currently applied ICC profiles, stored on the X server. This function returns a list of 3-tuples, each tuple contains the index of a screen, @@ -811,11 +812,20 @@ monitor in a screen is saved as a property named @var{_ICC_PROFILE_1}, the tertiary monitor is stored as @var{_ICC_PROFILE_2}, and so on. +If @code{display} is not specified or is @code{None}, +the current X display will be used. Otherwise, the +display indicated by @code{display} will be used. + @item get_current_icc() +@itemx get_current_icc(display) This function works like @code{get_current_icc_raw}, except rather than returning raw profile data it returns functions that apply the profiles when invoked. +If @code{display} is not specified or is @code{None}, +the current X display will be used. Otherwise, the +display indicated by @code{display} will be used. + @end table If you have multiple profiles you want to interpolate @@ -900,15 +910,20 @@ continuous mode. To support multiple monitors in a dynamic way, the function @code{list_screens} can be used. -@code{list_screens} has one optional parameter +@code{list_screens} has two optional parameters and returns the an instance of the class @code{Screens}. Instances of @code{Screens} have one variable: @code{screens}, a list of instances of the class @code{Screen}. The index of each screens is their index in @code{screens}. -@code{list_screens}'s parameter, @code{method}, -selects the method and defaults to `randr', -it also supports the method `drm'. +@code{list_screens}'s first parameter, +@code{method}, selects the method and defaults +to `randr', it also supports the method `drm'. +Its second parameters, @code{display}, is no +effect if `drm' is used for @code{method}, but +otherwise selects the X display to use. If +@code{display} is @code{None}, or is not +specified, the current X display will be used. Instances of the class @code{Screen} have two variables: @code{crtc_count}, the number of CRT -- cgit v1.2.3-70-g09d2