File: renderbuffer.rst

package info (click to toggle)
python-moderngl 5.12.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,700 kB
  • sloc: python: 15,758; cpp: 14,665; makefile: 14
file content (77 lines) | stat: -rw-r--r-- 1,830 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Renderbuffer
============

.. py:class:: Renderbuffer

    Returned by :py:meth:`Context.renderbuffer` or :py:meth:`Context.depth_renderbuffer`

    Renderbuffer objects are OpenGL objects that contain images.

    They are created and used specifically with :py:class:`Framebuffer` objects.
    They are optimized for use as render targets, while :py:class:`Texture` objects
    may not be, and are the logical choice when you do not need to sample
    from the produced image. If you need to resample, use Textures instead.
    Renderbuffer objects also natively accommodate multisampling.

    A Renderbuffer object cannot be instantiated directly, it requires a context.
    Use :py:meth:`Context.renderbuffer` or :py:meth:`Context.depth_renderbuffer`
    to create one.

Methods
-------

.. py:method:: Renderbuffer.release

Attributes
----------

.. py:attribute:: Renderbuffer.width
    :type: int

    The width of the renderbuffer.

.. py:attribute:: Renderbuffer.height
    :type: int

    The height of the renderbuffer.

.. py:attribute:: Renderbuffer.size
    :type: Tuple[int, int]

    The size of the renderbuffer.

.. py:attribute:: Renderbuffer.samples
    :type: int

    The number of samples for multisampling.

.. py:attribute:: Renderbuffer.components
    :type: int

    The number components.

.. py:attribute:: Renderbuffer.depth
    :type: bool

    Determines if the renderbuffer contains depth values.

.. py:attribute:: Renderbuffer.dtype
    :type: str

    Data type.

.. py:attribute:: Renderbuffer.ctx
    :type: Context

    The context this object belongs to

.. py:attribute:: Renderbuffer.glo
    :type: int

    The internal OpenGL object.
    This values is provided for interoperability and debug purposes only.

.. py:attribute:: Renderbuffer.extra
    :type: Any

    User defined data.