You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
126 lines
4.9 KiB
126 lines
4.9 KiB
.. |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
|
2020 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a |
|
copy of this software and associated documentation files (the "Software"), |
|
to deal in the Software without restriction, including without limitation |
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
and/or sell copies of the Software, and to permit persons to whom the |
|
Software is furnished to do so, subject to the following conditions: |
|
|
|
The above copyright notice and this permission notice shall be included |
|
in all copies or substantial portions of the Software. |
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
DEALINGS IN THE SOFTWARE. |
|
.. |
|
|
|
.. roles used for all other docs |
|
|
|
.. doctest setup |
|
>>> from magnum import * |
|
|
|
.. py:module:: magnum |
|
:data BUILD_STATIC: Static library build |
|
:data TARGET_GL: OpenGL interoperability |
|
:data TARGET_GLES: OpenGL ES target |
|
:data TARGET_GLES2: OpenGL ES 2.0 target |
|
:data TARGET_WEBGL: WebGL target |
|
:data TARGET_VK: Vulkan interoperability |
|
|
|
.. py:class:: magnum.Image1D |
|
|
|
See :ref:`Image2D` for more information. |
|
|
|
.. py:class:: magnum.Image2D |
|
|
|
An owning counterpart to :ref:`ImageView2D` / :ref:`MutableImageView2D`. |
|
Holds its own data buffer, thus doesn't have an equivalent to |
|
:ref:`ImageView2D.owner`. Implicitly convertible to :ref:`ImageView2D` / |
|
:ref:`MutableImageView2D`, so all APIs consuming image views work with this |
|
type as well. |
|
|
|
.. py:class:: magnum.Image3D |
|
|
|
See :ref:`Image2D` for more information. |
|
|
|
.. py:class:: magnum.ImageView1D |
|
|
|
See :ref:`ImageView2D` for more information. |
|
|
|
.. py:class:: magnum.ImageView2D |
|
|
|
:TODO: remove this line once m.css stops ignoring first caption on a page |
|
|
|
`Memory ownership and reference counting`_ |
|
========================================== |
|
|
|
Similarly to :ref:`corrade.containers.ArrayView` (and unlike in C++), the |
|
view keeps a reference to the original memory owner object in the |
|
:ref:`owner` field, meaning that calling :py:`del` on the original object |
|
will *not* invalidate the view. Slicing a view creates a new view |
|
referencing the same original object, without any dependency on the |
|
previous view. That means a long chained slicing operation will not cause |
|
increased memory usage. |
|
|
|
The :ref:`owner` is :py:`None` if the view is empty. |
|
|
|
.. py:class:: magnum.ImageView3D |
|
|
|
See :ref:`ImageView2D` for more information. |
|
|
|
.. py:class:: magnum.MutableImageView1D |
|
|
|
See :ref:`ImageView2D` for more information. |
|
|
|
.. py:class:: magnum.MutableImageView2D |
|
|
|
See :ref:`ImageView2D` for more information. |
|
|
|
.. py:class:: magnum.MutableImageView3D |
|
|
|
See :ref:`ImageView2D` for more information. |
|
|
|
.. py:function:: magnum.ImageView1D.__init__(self, arg0: magnum.ImageView1D) |
|
:raise RuntimeError: If :ref:`trade.ImageData1D.is_compressed` is :py:`True` |
|
|
|
This function is used to implement implicit conversion from |
|
:ref:`trade.ImageData1D` in the :ref:`trade` module. |
|
|
|
.. py:function:: magnum.ImageView2D.__init__(self, arg0: magnum.ImageView2D) |
|
:raise RuntimeError: If :ref:`trade.ImageData2D.is_compressed` is :py:`True` |
|
|
|
This function is used to implement implicit conversion from |
|
:ref:`trade.ImageData2D` in the :ref:`trade` module. |
|
|
|
.. py:function:: magnum.ImageView3D.__init__(self, arg0: magnum.ImageView3D) |
|
:raise RuntimeError: If :ref:`trade.ImageData3D.is_compressed` is :py:`True` |
|
|
|
This function is used to implement implicit conversion from |
|
:ref:`trade.ImageData3D` in the :ref:`trade` module. |
|
|
|
.. py:function:: magnum.MutableImageView1D.__init__(self, arg0: magnum.MutableImageView1D) |
|
:raise RuntimeError: If :ref:`trade.ImageData1D.is_compressed` is :py:`True` |
|
|
|
This function is used to implement implicit conversion from |
|
:ref:`trade.ImageData1D` in the :ref:`trade` module. |
|
|
|
.. py:function:: magnum.MutableImageView2D.__init__(self, arg0: magnum.MutableImageView2D) |
|
:raise RuntimeError: If :ref:`trade.ImageData2D.is_compressed` is :py:`True` |
|
|
|
This function is used to implement implicit conversion from |
|
:ref:`trade.ImageData2D` in the :ref:`trade` module. |
|
|
|
.. py:function:: magnum.MutableImageView3D.__init__(self, arg0: magnum.MutableImageView3D) |
|
:raise RuntimeError: If :ref:`trade.ImageData3D.is_compressed` is :py:`True` |
|
|
|
This function is used to implement implicit conversion from |
|
:ref:`trade.ImageData3D` in the :ref:`trade` module.
|
|
|