framebuffer

  1# This file was automatically generated by SWIG (https://www.swig.org).
  2# Version 4.2.1
  3#
  4# Do not make changes to this file unless you know what you are doing - modify
  5# the SWIG interface file instead.
  6
  7from sys import version_info as _swig_python_version_info
  8from mock_rtems import _framebuffer as _framebuffer
  9
 10try:
 11    import builtins as __builtin__
 12except ImportError:
 13    import __builtin__
 14
 15def _swig_repr(self):
 16    try:
 17        strthis = "proxy of " + self.this.__repr__()
 18    except __builtin__.Exception:
 19        strthis = ""
 20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
 21
 22
 23def _swig_setattr_nondynamic_instance_variable(set):
 24    def set_instance_attr(self, name, value):
 25        if name == "this":
 26            set(self, name, value)
 27        elif name == "thisown":
 28            self.this.own(value)
 29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
 30            set(self, name, value)
 31        else:
 32            raise AttributeError("You cannot add instance attributes to %s" % self)
 33    return set_instance_attr
 34
 35
 36def _swig_setattr_nondynamic_class_variable(set):
 37    def set_class_attr(cls, name, value):
 38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
 39            set(cls, name, value)
 40        else:
 41            raise AttributeError("You cannot add class attributes to %s" % cls)
 42    return set_class_attr
 43
 44
 45def _swig_add_metaclass(metaclass):
 46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
 47    def wrapper(cls):
 48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
 49    return wrapper
 50
 51
 52class _SwigNonDynamicMeta(type):
 53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
 54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
 55
 56
 57FRAMEBUFFER_DEVICE_NAME = _framebuffer.FRAMEBUFFER_DEVICE_NAME
 58r"""
 59    This macro defines the standard name for the frame buffer device
 60    that is available to applications.
 61    """
 62FRAMEBUFFER_DEVICE_0_NAME = _framebuffer.FRAMEBUFFER_DEVICE_0_NAME
 63r"""
 64    Standard device file path of first frame buffer device.
 65
 66    This device is the default frame buffer device for the Microwindows Screen
 67    Driver.
 68    """
 69
 70def frame_buffer_initialize(major, minor, arg):
 71    r"""
 72    This macro defines the standard device driver table entry for
 73    a frame buffer device driver.
 74
 75    Frame Buffer Initialization Entry Point
 76
 77    This method initializes the frame buffer device driver.
 78
 79    :type major: rtems_device_major_number, in
 80    :param major: is the device driver major number
 81    :type minor: rtems_device_minor_number, in
 82    :param minor: is the device driver minor number
 83    :type arg: void, in
 84    :param arg: is the parameters to this call
 85
 86    :rtype: rtems_device_driver
 87    :return: This method returns RTEMS_SUCCESSFUL when
 88                the device driver is successfully initialized.
 89    """
 90    return _framebuffer.frame_buffer_initialize(major, minor, arg)
 91
 92def frame_buffer_open(major, minor, arg):
 93    r"""
 94    Frame Buffer Open Entry Point
 95
 96    This method opens a specific device supported by the
 97    frame buffer device driver.
 98
 99    :type major: rtems_device_major_number, in
100    :param major: is the device driver major number
101    :type minor: rtems_device_minor_number, in
102    :param minor: is the device driver minor number
103    :type arg: void, in
104    :param arg: is the parameters to this call
105
106    :rtype: rtems_device_driver
107    :return: This method returns RTEMS_SUCCESSFUL when
108                the device driver is successfully opened.
109    """
110    return _framebuffer.frame_buffer_open(major, minor, arg)
111
112def frame_buffer_close(major, minor, arg):
113    r"""
114    Frame Buffer Close Entry Point
115
116    This method closes a specific device supported by the
117    frame buffer device driver.
118
119    :type major: rtems_device_major_number, in
120    :param major: is the device driver major number
121    :type minor: rtems_device_minor_number, in
122    :param minor: is the device driver minor number
123    :type arg: void, in
124    :param arg: is the parameters to this call
125
126    :rtype: rtems_device_driver
127    :return: This method returns RTEMS_SUCCESSFUL when
128                the device is successfully closed.
129    """
130    return _framebuffer.frame_buffer_close(major, minor, arg)
131
132def frame_buffer_read(major, minor, arg):
133    r"""
134    Frame Buffer Read Entry Point
135
136    This method reads from a specific device supported by the
137    frame buffer device driver.
138
139    :type major: rtems_device_major_number, in
140    :param major: is the device driver major number
141    :type minor: rtems_device_minor_number, in
142    :param minor: is the device driver minor number
143    :type arg: void, in
144    :param arg: is the parameters to this call
145
146    :rtype: rtems_device_driver
147    :return: This method returns RTEMS_SUCCESSFUL when
148                the device is successfully read from.
149    """
150    return _framebuffer.frame_buffer_read(major, minor, arg)
151
152def frame_buffer_write(major, minor, arg):
153    r"""
154    Frame Buffer Write Entry Point
155
156    This method writes to a specific device supported by the
157    frame buffer device driver.
158
159    :type major: rtems_device_major_number, in
160    :param major: is the device driver major number
161    :type minor: rtems_device_minor_number, in
162    :param minor: is the device driver minor number
163    :type arg: void, in
164    :param arg: is the parameters to this call
165
166    :rtype: rtems_device_driver
167    :return: This method returns RTEMS_SUCCESSFUL when
168                the device is successfully written.
169    """
170    return _framebuffer.frame_buffer_write(major, minor, arg)
171
172def frame_buffer_control(major, minor, arg):
173    r"""
174    Frame Buffer IO Control Entry Point
175
176    This method performs an IO Control operation on a
177    specific device supported by the frame buffer device driver.
178
179    :type major: rtems_device_major_number, in
180    :param major: is the device driver major number
181    :type minor: rtems_device_minor_number, in
182    :param minor: is the device driver minor number
183    :type arg: void, in
184    :param arg: is the parameters to this call
185
186    :rtype: rtems_device_driver
187    :return: This method returns RTEMS_SUCCESSFUL when
188                the device driver IO control operation is
189                successfully performed.
190    """
191    return _framebuffer.frame_buffer_control(major, minor, arg)
FRAMEBUFFER_DEVICE_NAME = See C documentation

This macro defines the standard name for the frame buffer device that is available to applications.

FRAMEBUFFER_DEVICE_0_NAME = See C documentation

Standard device file path of first frame buffer device.

This device is the default frame buffer device for the Microwindows Screen Driver.

def frame_buffer_initialize(major, minor, arg):
71def frame_buffer_initialize(major, minor, arg):
72    r"""
73    This macro defines the standard device driver table entry for
74    a frame buffer device driver.
75
76    Frame Buffer Initialization Entry Point
77
78    This method initializes the frame buffer device driver.
79
80    :type major: rtems_device_major_number, in
81    :param major: is the device driver major number
82    :type minor: rtems_device_minor_number, in
83    :param minor: is the device driver minor number
84    :type arg: void, in
85    :param arg: is the parameters to this call
86
87    :rtype: rtems_device_driver
88    :return: This method returns RTEMS_SUCCESSFUL when
89                the device driver is successfully initialized.
90    """
91    return _framebuffer.frame_buffer_initialize(major, minor, arg)

This macro defines the standard device driver table entry for a frame buffer device driver.

Frame Buffer Initialization Entry Point

This method initializes the frame buffer device driver.

Parameters
  • major: is the device driver major number
  • minor: is the device driver minor number
  • arg: is the parameters to this call
Returns

This method returns RTEMS_SUCCESSFUL when the device driver is successfully initialized.

def frame_buffer_open(major, minor, arg):
 93def frame_buffer_open(major, minor, arg):
 94    r"""
 95    Frame Buffer Open Entry Point
 96
 97    This method opens a specific device supported by the
 98    frame buffer device driver.
 99
100    :type major: rtems_device_major_number, in
101    :param major: is the device driver major number
102    :type minor: rtems_device_minor_number, in
103    :param minor: is the device driver minor number
104    :type arg: void, in
105    :param arg: is the parameters to this call
106
107    :rtype: rtems_device_driver
108    :return: This method returns RTEMS_SUCCESSFUL when
109                the device driver is successfully opened.
110    """
111    return _framebuffer.frame_buffer_open(major, minor, arg)

Frame Buffer Open Entry Point

This method opens a specific device supported by the frame buffer device driver.

Parameters
  • major: is the device driver major number
  • minor: is the device driver minor number
  • arg: is the parameters to this call
Returns

This method returns RTEMS_SUCCESSFUL when the device driver is successfully opened.

def frame_buffer_close(major, minor, arg):
113def frame_buffer_close(major, minor, arg):
114    r"""
115    Frame Buffer Close Entry Point
116
117    This method closes a specific device supported by the
118    frame buffer device driver.
119
120    :type major: rtems_device_major_number, in
121    :param major: is the device driver major number
122    :type minor: rtems_device_minor_number, in
123    :param minor: is the device driver minor number
124    :type arg: void, in
125    :param arg: is the parameters to this call
126
127    :rtype: rtems_device_driver
128    :return: This method returns RTEMS_SUCCESSFUL when
129                the device is successfully closed.
130    """
131    return _framebuffer.frame_buffer_close(major, minor, arg)

Frame Buffer Close Entry Point

This method closes a specific device supported by the frame buffer device driver.

Parameters
  • major: is the device driver major number
  • minor: is the device driver minor number
  • arg: is the parameters to this call
Returns

This method returns RTEMS_SUCCESSFUL when the device is successfully closed.

def frame_buffer_read(major, minor, arg):
133def frame_buffer_read(major, minor, arg):
134    r"""
135    Frame Buffer Read Entry Point
136
137    This method reads from a specific device supported by the
138    frame buffer device driver.
139
140    :type major: rtems_device_major_number, in
141    :param major: is the device driver major number
142    :type minor: rtems_device_minor_number, in
143    :param minor: is the device driver minor number
144    :type arg: void, in
145    :param arg: is the parameters to this call
146
147    :rtype: rtems_device_driver
148    :return: This method returns RTEMS_SUCCESSFUL when
149                the device is successfully read from.
150    """
151    return _framebuffer.frame_buffer_read(major, minor, arg)

Frame Buffer Read Entry Point

This method reads from a specific device supported by the frame buffer device driver.

Parameters
  • major: is the device driver major number
  • minor: is the device driver minor number
  • arg: is the parameters to this call
Returns

This method returns RTEMS_SUCCESSFUL when the device is successfully read from.

def frame_buffer_write(major, minor, arg):
153def frame_buffer_write(major, minor, arg):
154    r"""
155    Frame Buffer Write Entry Point
156
157    This method writes to a specific device supported by the
158    frame buffer device driver.
159
160    :type major: rtems_device_major_number, in
161    :param major: is the device driver major number
162    :type minor: rtems_device_minor_number, in
163    :param minor: is the device driver minor number
164    :type arg: void, in
165    :param arg: is the parameters to this call
166
167    :rtype: rtems_device_driver
168    :return: This method returns RTEMS_SUCCESSFUL when
169                the device is successfully written.
170    """
171    return _framebuffer.frame_buffer_write(major, minor, arg)

Frame Buffer Write Entry Point

This method writes to a specific device supported by the frame buffer device driver.

Parameters
  • major: is the device driver major number
  • minor: is the device driver minor number
  • arg: is the parameters to this call
Returns

This method returns RTEMS_SUCCESSFUL when the device is successfully written.

def frame_buffer_control(major, minor, arg):
173def frame_buffer_control(major, minor, arg):
174    r"""
175    Frame Buffer IO Control Entry Point
176
177    This method performs an IO Control operation on a
178    specific device supported by the frame buffer device driver.
179
180    :type major: rtems_device_major_number, in
181    :param major: is the device driver major number
182    :type minor: rtems_device_minor_number, in
183    :param minor: is the device driver minor number
184    :type arg: void, in
185    :param arg: is the parameters to this call
186
187    :rtype: rtems_device_driver
188    :return: This method returns RTEMS_SUCCESSFUL when
189                the device driver IO control operation is
190                successfully performed.
191    """
192    return _framebuffer.frame_buffer_control(major, minor, arg)

Frame Buffer IO Control Entry Point

This method performs an IO Control operation on a specific device supported by the frame buffer device driver.

Parameters
  • major: is the device driver major number
  • minor: is the device driver minor number
  • arg: is the parameters to this call
Returns

This method returns RTEMS_SUCCESSFUL when the device driver IO control operation is successfully performed.