File: wx.GraphicsBitmap.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (147 lines) | stat: -rw-r--r-- 4,749 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.GraphicsBitmap:

==========================================================================================================================================
|phoenix_title|  **wx.GraphicsBitmap**
==========================================================================================================================================

Represents a bitmap.          

The objects of this class are not created directly but only via :ref:`wx.GraphicsContext`  or :ref:`wx.GraphicsRenderer`  CreateBitmap(), CreateBitmapFromImage() or CreateSubBitmap() methods. They can subsequently be used with :meth:`wx.GraphicsContext.DrawBitmap` . The only other operation is testing for the bitmap validity which can be performed using :meth:`~wx.GraphicsBitmap.IsNull`  method inherited from the base class.           




|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>GraphicsBitmap</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.GraphicsBitmap_inheritance.png" alt="Inheritance diagram of GraphicsBitmap" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="36,5,117,35"/> <area shape="rect" id="node3" href="wx.GraphicsObject.html" title="wx.GraphicsObject" alt="" coords="8,83,147,112"/> <area shape="rect" id="node2" href="wx.GraphicsBitmap.html" title="wx.GraphicsBitmap" alt="" coords="5,160,149,189"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.GraphicsBitmap.__init__`                                              Default constructor creates an invalid bitmap.
:meth:`~wx.GraphicsBitmap.ConvertToImage`                                        Return the contents of this bitmap as :ref:`wx.Image`.
:meth:`~wx.GraphicsBitmap.GetNativeBitmap`                                       Return the pointer to the native bitmap data.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.GraphicsBitmap.NativeBitmap`                                          See :meth:`~wx.GraphicsBitmap.GetNativeBitmap`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.GraphicsBitmap(GraphicsObject)

   **Possible constructors**::

       GraphicsBitmap()
       
   
   Represents a bitmap.



   .. method:: __init__(self)

      Default constructor creates an invalid bitmap.                   





   .. method:: ConvertToImage(self)

      Return the contents of this bitmap as :ref:`wx.Image`.                  

      Using this method is more efficient than converting :ref:`wx.GraphicsBitmap`  to :ref:`wx.Bitmap`  first and then to :ref:`wx.Image`  and can be useful if, for example, you want to save :ref:`wx.GraphicsBitmap`  as a disk file in a format not directly supported by :ref:`wx.Bitmap`. 

      Invalid image is returned if the bitmap is invalid. 

                

      :rtype: :ref:`wx.Image`







      .. versionadded:: 2.9.3 
     








   .. method:: GetNativeBitmap(self)

      Return the pointer to the native bitmap data.                  

      (CGImageRef for Core Graphics, cairo_surface_t for Cairo, Bitmap for GDI+.) 

                 



      .. versionadded:: 2.9.4 
     








   .. attribute:: NativeBitmap

      See :meth:`~wx.GraphicsBitmap.GetNativeBitmap`