aboutsummaryrefslogtreecommitdiffstats
path: root/libgamma_facade.py
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2022-07-21 14:53:18 +0200
committerMattias Andrée <maandree@kth.se>2022-07-21 14:53:18 +0200
commit3be28b4e8f75190d30e311f0e69da714cac62cc5 (patch)
tree95374a0ac30802f838e0fee1d7c686b66dd26b11 /libgamma_facade.py
parentRemove dist (diff)
downloadpylibgamma-1.1.3.tar.gz
pylibgamma-1.1.3.tar.bz2
pylibgamma-1.1.3.tar.xz
Change license to ISC, change style, improve makefile1.1.3
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--libgamma_facade.py (renamed from src/libgamma_facade.py)85
1 files changed, 32 insertions, 53 deletions
diff --git a/src/libgamma_facade.py b/libgamma_facade.py
index 5920a5b..ac2ec2c 100644
--- a/src/libgamma_facade.py
+++ b/libgamma_facade.py
@@ -1,39 +1,19 @@
-# -*- python -*-
-'''
-pylibgamma — Python 3 wrapper for libgamma
-Copyright © 2014 Mattias Andrée (maandree@member.fsf.org)
-
-This library is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this library. If not, see <http://www.gnu.org/licenses/>.
-'''
-
-
+# See LICENSE file for copyright and license details.
from libgamma_method import MethodCapabilities
-
def list_methods(operation : int) -> list:
'''
- List available adjustment methods by their order of preference based on the environment.
+ List available adjustment methods by their order of preference based on the environment
- @param operation Allowed values:
- 0: Methods that the environment suggests will work, excluding fake.
- 1: Methods that the environment suggests will work, including fake.
- 2: All real non-fake methods.
- 3: All real methods.
- 4: All methods.
- Other values invoke undefined behaviour.
- @return :list<int> A list of available adjustment methods.
+ @param operation Allowed values
+ 0: Methods that the environment suggests will work, excluding fake
+ 1: Methods that the environment suggests will work, including fake
+ 2: All real non-fake methods
+ 3: All real methods
+ 4: All methods
+ Other values invoke undefined behaviour
+ @return :list<int> A list of available adjustment methods
'''
from libgamma_native_facade import libgamma_native_list_methods
return libgamma_native_list_methods(operation)
@@ -42,10 +22,10 @@ def list_methods(operation : int) -> list:
def is_method_available(method : int) -> bool:
'''
Check whether an adjustment method is available, non-existing (invalid) methods will be
- identified as not available under the rationale that the library may be out of date.
+ identified as not available under the rationale that the library may be out of date
- @param method The adjustment method.
- @return Whether the adjustment method is available.
+ @param method The adjustment method
+ @return Whether the adjustment method is available
'''
from libgamma_native_facade import libgamma_native_is_method_available
return not libgamma_native_is_method_available(method) == 0
@@ -53,10 +33,10 @@ def is_method_available(method : int) -> bool:
def method_capabilities(method : int) -> MethodCapabilities:
'''
- Return the capabilities of an adjustment method.
+ Return the capabilities of an adjustment method
@param this The data structure to fill with the method's capabilities
- @param method The adjustment method (display server and protocol).
+ @param method The adjustment method (display server and protocol)
'''
from libgamma_native_facade import libgamma_native_method_capabilities
caps = libgamma_native_method_capabilities(method)
@@ -65,12 +45,12 @@ def method_capabilities(method : int) -> MethodCapabilities:
def method_default_site(method : int) -> str:
'''
- Return the default site for an adjustment method.
+ Return the default site for an adjustment method
- @param method The adjustment method (display server and protocol.)
+ @param method The adjustment method (display server and protocol)
@return The default site, `None` if it cannot be determined or
if multiple sites are not supported by the adjustment
- method.
+ method
'''
from libgamma_native_facade import libgamma_native_method_default_site
return libgamma_native_method_default_site(method)
@@ -79,9 +59,9 @@ def method_default_site(method : int) -> str:
def method_default_site_variable(method : int) -> str:
'''
Return the default variable that determines
- the default site for an adjustment method.
+ the default site for an adjustment method
- @param method The adjustment method (display server and protocol.)
+ @param method The adjustment method (display server and protocol)
@return The environ variables that is used to determine the
default site. `None` if there is none, that is, if
the method does not support multiple sites.
@@ -93,20 +73,20 @@ def method_default_site_variable(method : int) -> str:
def behex_edid(edid : bytes) -> str:
'''
- Convert a raw representation of an EDID to a lowercase hexadecimal representation.
+ Convert a raw representation of an EDID to a lowercase hexadecimal representation
- @param edid The EDID in raw representation.
- @return The EDID in lowercase hexadecimal representation.
+ @param edid The EDID in raw representation
+ @return The EDID in lowercase hexadecimal representation
'''
return behex_edid_lowercase(edid)
def behex_edid_lowercase(edid : bytes) -> str:
'''
- Convert a raw representation of an EDID to a lowercase hexadecimal representation.
+ Convert a raw representation of an EDID to a lowercase hexadecimal representation
- @param edid The EDID in raw representation.
- @return The EDID in lowercase hexadecimal representation.
+ @param edid The EDID in raw representation
+ @return The EDID in lowercase hexadecimal representation
'''
rc = ''
for b in edid:
@@ -117,10 +97,10 @@ def behex_edid_lowercase(edid : bytes) -> str:
def behex_edid_uppercase(edid : bytes) -> str:
'''
- Convert a raw representation of an EDID to an uppercase hexadecimal representation.
+ Convert a raw representation of an EDID to an uppercase hexadecimal representation
- @param edid The EDID in raw representation.
- @return The EDID in uppercase hexadecimal representation.
+ @param edid The EDID in raw representation
+ @return The EDID in uppercase hexadecimal representation
'''
rc = ''
for b in edid:
@@ -131,10 +111,10 @@ def behex_edid_uppercase(edid : bytes) -> str:
def unhex_edid(edid : str) -> bytes:
'''
- Convert an hexadecimal representation of an EDID to a raw representation.
+ Convert an hexadecimal representation of an EDID to a raw representation
- @param edid The EDID in hexadecimal representation.
- @return The EDID in raw representation.
+ @param edid The EDID in hexadecimal representation
+ @return The EDID in raw representation
'''
rc = []
edid = edid.lower()
@@ -144,4 +124,3 @@ def unhex_edid(edid : str) -> bytes:
b = '0123456789abcdef'.find(b) << 0
rc.append(a | b)
return bytes(rc)
-