Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2026-01-08 13:00:07 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add FromPNGData factory, and fix markup in some docstrings

Browse Source
This commit is contained in:
Robin Dunn
2020-07-29 14:19:45 -07:00
parent 428237a6f9
commit d061009b9e
3 changed files with 37 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
docs/sphinx/rest_substitutions/snippets/python/converted/wx.Bitmap.NewFromPNGData.1.py
View File

2
docs/sphinx/rest_substitutions/snippets/python/converted/wx.Bitmap.NewFromPNGData.2.py
View File

@@ -1,2 +0,0 @@
wx.Image.AddHandler(wx.PNGHandler)

55
etg/bitmap.py
View File

@@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
#---------------------------------------------------------------------------
# Name: etg/bitmap.py
# Author: Kevin Ollivier
@@ -9,6 +10,8 @@
# License: wxWindows License
#---------------------------------------------------------------------------
from textwrap import dedent
import etgtools
import etgtools.tweaker_tools as tools
@@ -164,7 +167,7 @@ def run():
c.addCppMethod('void', 'CopyFromBuffer',
'(wxPyBuffer* data, wxBitmapBufferFormat format=wxBitmapBufferFormat_RGB, int stride=-1)',
doc="""\
doc=dedent("""\
Copy data from a buffer object to replace the bitmap pixel data.
Default format is plain RGB, but other formats are now supported as
well. The following symbols are used to specify the format of the
@@ -175,7 +178,7 @@ def run():
wx.BitmapBufferFormat_RGBA A simple sequence of RGBA bytes
wx.BitmapBufferFormat_ARGB32 A sequence of 32-bit values in native endian order, with alpha in the upper 8 bits, followed by red, green, and blue.
wx.BitmapBufferFormat_RGB32 Same as above but the alpha byte is ignored.
============================= ================================""",
============================= ================================"""),
body="""\
wxPyCopyBitmapFromBuffer(self, (byte*)data->m_ptr, data->m_len, format, stride);
""")
@@ -183,9 +186,9 @@ def run():
c.addCppMethod('void', 'CopyToBuffer',
'(wxPyBuffer* data, wxBitmapBufferFormat format=wxBitmapBufferFormat_RGB, int stride=-1)',
doc="""\
doc=dedent("""\
Copy pixel data to a buffer object. See :meth:`CopyFromBuffer` for buffer
format details.""",
format details."""),
body="""\
wxPyCopyBitmapToBuffer(self, (byte*)data->m_ptr, data->m_len, format, stride);
""")
@@ -197,13 +200,13 @@ def run():
'(int width, int height, wxPyBuffer* data, wxPyBuffer* alpha)',
isStatic=True,
factory=True,
doc="""\
doc=dedent("""\
Creates a :class:`wx.Bitmap` from in-memory data. The data and alpha
parameters must be a Python object that implements the buffer
interface, such as a string, bytearray, etc. The data object
is expected to contain a series of RGB bytes and be at least
(width * height * 3) bytes long, while the alpha object is expected
to be width*height bytes long and represents the image's alpha
``(width ∗ height ∗ 3)`` bytes long, while the alpha object is expected
to be ``(width ∗ height)`` bytes long and represents the image's alpha
channel. On Windows and Mac the RGB values will be
'premultiplied' by the alpha values. (The other platforms do
the multiplication themselves.)
@@ -214,7 +217,7 @@ def run():
platforms, and so instead an efficient as possible copy of the
data is made from the buffer object to the bitmap's native pixel
buffer.
""",
"""),
body="""\
if (!data->checkSize(width*height*3) || !alpha->checkSize(width*height))
return NULL;
@@ -249,11 +252,11 @@ def run():
c.addCppMethod('wxBitmap*', 'FromBuffer', '(int width, int height, wxPyBuffer* data)',
isStatic=True,
factory=True,
doc="""\
doc=dedent("""\
Creates a :class:`wx.Bitmap` from in-memory data. The data parameter
must be a Python object that implements the buffer interface, such
as a string, bytearray, etc. The data object is expected to contain
a series of RGB bytes and be at least (width * height * 3) bytes long.
a series of RGB bytes and be at least ``(width ∗ height ∗ 3)`` bytes long.
Unlike :func:`wx.ImageFromBuffer` the bitmap created with this function
does not share the memory block with the buffer object. This is
@@ -261,7 +264,7 @@ def run():
platforms, and so instead an efficient as possible copy of the
data is made from the buffer object to the bitmap's native pixel
buffer.
""",
"""),
body="""\
wxBitmap* bmp = new wxBitmap(width, height, 24);
wxPyCopyBitmapFromBuffer(bmp, (byte*)data->m_ptr, data->m_len, wxBitmapBufferFormat_RGB);
@@ -289,11 +292,11 @@ def run():
c.addCppMethod('wxBitmap*', 'FromBufferRGBA', '(int width, int height, wxPyBuffer* data)',
isStatic=True,
factory=True,
doc="""\
doc=dedent("""\
Creates a :class:`wx.Bitmap` from in-memory data. The data parameter
must be a Python object that implements the buffer interface, such
as a string, bytearray, etc. The data object is expected to contain
a series of RGBA bytes and be at least (width * height * 4) bytes long.
a series of RGBA bytes and be at least ``(width ∗ height ∗ 4)`` bytes long.
On Windows and Mac the RGB values will be 'premultiplied' by the
alpha values. (The other platforms do the multiplication themselves.)
@@ -303,7 +306,7 @@ def run():
platforms, and so instead an efficient as possible copy of the
data is made from the buffer object to the bitmap's native pixel
buffer.
""",
"""),
body="""\
wxBitmap* bmp = new wxBitmap(width, height, 32);
wxPyCopyBitmapFromBuffer(bmp, (byte*)data->m_ptr, data->m_len, wxBitmapBufferFormat_RGBA);
@@ -321,16 +324,14 @@ def run():
body='return Bitmap.FromBufferRGBA(width, height, dataBuffer)')
c.addCppMethod('wxBitmap*', 'FromRGBA',
'(int width, int height, byte red=0, byte green=0, byte blue=0, byte alpha=0)',
isStatic=True,
factory=True,
doc="""\
doc=dedent("""\
Creates a new empty 32-bit :class:`wx.Bitmap` where every pixel has been
initialized with the given RGBA values.
""",
"""),
body="""\
if ( !(width > 0 && height > 0) ) {
wxPyErr_SetString(PyExc_ValueError, "Width and height must be greater than zero");
@@ -360,6 +361,24 @@ def run():
return bmp;
""")
c.find('NewFromPNGData').detailedDoc = [dedent("""\
This helper function provides the simplest way to create a wx.Bitmap from
in-memory PNG image data.
""")]
c.addCppMethod('wxBitmap*', 'FromPNGData', '(wxPyBuffer* data)',
isStatic=True,
factory=True,
doc=dedent("""\
Like :meth:`NewFromPNGData`, but with a simpler API accepting a Python
buffer-compatible object.
"""),
body="""\
wxBitmap bmp = wxBitmap::NewFromPNGData(data->m_ptr, data->m_len);
return new wxBitmap(bmp);
""" )
module.addPyFunction('EmptyBitmapRGBA', '(width, height, red=0, green=0, blue=0, alpha=0)',
deprecated="Use :meth:`wx.Bitmap.FromRGBA` instead.",
doc='A compatibility wrapper for :meth:`wx.Bitmap.FromRGBA`',