~ubuntu-branches/ubuntu/maverick/pygame/maverick

<td bgcolor='#c2fc20' style='padding: 6px;' align=center valign=center><a href='http://www.pygame.org/'><img src='../pygame_tiny.gif' border=0 width=200 height=60></a> pygame documentation</td>

<a href=http://www.pygame.org>Pygame Home</a>  ||

<a href=../index.html>Help Contents</a>  ||

<a href=index.html>Reference Index</a>  ||

<a href="camera.html">Camera</a> ||

<a href="cdrom.html">Cdrom</a> ||

<a href="color.html">Color</a> ||

<a href="cursors.html">Cursors</a> ||

<a href="display.html">Display</a> ||

<a href="draw.html">Draw</a> ||

<a href="event.html">Event</a> ||

<a href="examples.html">Examples</a> ||

<a href="font.html">Font</a> ||

<a href="gfxdraw.html">Gfxdraw</a> ||

<a href="image.html">Image</a> ||

<a href="joystick.html">Joystick</a> ||

<a href="key.html">Key</a> ||

<a href="locals.html">Locals</a> ||

<a href="mask.html">Mask</a> ||

<a href="midi.html">Midi</a> ||

<a href="mixer.html">Mixer</a> ||

<a href="mouse.html">Mouse</a> ||

<a href="movie.html">Movie</a> ||

<a href="music.html">Music</a> ||

<a href="overlay.html">Overlay</a> ||

<a href="pixelarray.html">Pixelarray</a> ||

<a href="pygame.html">Pygame</a> ||

<a href="rect.html">Rect</a> ||

<a href="scrap.html">Scrap</a> ||

<a href="sndarray.html">Sndarray</a> ||

<a href="sprite.html">Sprite</a> ||

<a href="surface.html">Surface</a> ||

<a href="surfarray.html">Surfarray</a> ||

<a href="tests.html">Tests</a> ||

<a href="time.html">Time</a> ||

<a href="transform.html">Transform</a>

</td></tr></table>

<big>pygame.camera</big> <ul>

pygame module for camera use

<tr><td><a href="camera.html#pygame.camera.colorspace">pygame.camera.colorspace</a> - Surface colorspace conversion</td><td>Surface colorspace conversion</td></tr>

<tr><td><a href="camera.html#pygame.camera.list_cameras">pygame.camera.list_cameras</a> - returns a list of available cameras</td><td>returns a list of available cameras</td></tr>

<tr><td><a href="camera.html#pygame.camera.Camera">pygame.camera.Camera</a> - load a camera</td><td>load a camera</td></tr>

</table></ul>

Pygame currently supports only Linux and v4l2 cameras.

<tt>EXPERIMENTAL!:</tt> This api may change or disappear in later pygame releases. If you use this, your code will very likely break with the next pygame release.

The Bayer to <tt>RGB</tt> function is based on:

<pre> Sonix SN9C101 based webcam basic I/F routines

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions

are met:

1. Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the

documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

SUCH DAMAGE.

</pre>New in pygame <tt>1.9.0</tt>.

<big>pygame.camera.colorspace</big> <ul>

Surface colorspace conversion

<tt>pygame.camera.colorspace(Surface, format, DestSurface = None): return Surface</tt>

Allows for conversion from <tt>"RGB"</tt> to a destination colorspace of <tt>"HSV"</tt> or <tt>"YUV"</tt>. The source and destination surfaces must be the same size and pixel depth. This is useful for computer vision on devices with limited processing power. Capture as small of an image as possible, <tt>transform.scale()</tt> it even smaller, and then convert the colorspace to <tt>YUV</tt> or <tt>HSV</tt> before doing any processing on it.

</ul>

<big>pygame.camera.list_cameras</big> <ul>

100

returns a list of available cameras

101

<tt>pygame.camera.list_cameras(): return [cameras]</tt>

102

Checks the computer for available cameras and returns a list of strings of camera names, ready to be fed into <tt>pygame.camera.Camera</tt>.

103

104

</ul>

105

106

107

108

<big>pygame.camera.Camera</big> <ul>

109

load a camera

110

<tt>pygame.camera.Camera(device, (width, height), format): return Camera</tt>

111

112

<tr><td><a href="camera.html#Camera.start">Camera.start</a> - opens, initializes, and starts capturing</td><td>opens, initializes, and starts capturing</td></tr>

113

<tr><td><a href="camera.html#Camera.stop">Camera.stop</a> - stops, uninitializes, and closes the camera</td><td>stops, uninitializes, and closes the camera</td></tr>

114

<tr><td><a href="camera.html#Camera.get_controls">Camera.get_controls</a> - gets current values of user controls</td><td>gets current values of user controls</td></tr>

115

<tr><td><a href="camera.html#Camera.set_controls">Camera.set_controls</a> - changes camera settings if supported by the camera</td><td>changes camera settings if supported by the camera</td></tr>

116

<tr><td><a href="camera.html#Camera.get_size">Camera.get_size</a> - returns the dimensions of the images being recorded</td><td>returns the dimensions of the images being recorded</td></tr>

117

<tr><td><a href="camera.html#Camera.query_image">Camera.query_image</a> - checks if a frame is ready</td><td>checks if a frame is ready</td></tr>

118

<tr><td><a href="camera.html#Camera.get_image">Camera.get_image</a> - captures an image as a Surface</td><td>captures an image as a Surface</td></tr>

119

<tr><td><a href="camera.html#Camera.get_raw">Camera.get_raw</a> - returns an unmodified image as a string</td><td>returns an unmodified image as a string</td></tr>

120

</table></ul>

121

Loads a v4l2 camera. The device is typically something like "/dev/video0". Default width and height are 640 by 480. Format is the desired colorspace of the output. This is useful for computer vision purposes. The default is <tt>RGB</tt>. The following are supported:

122

<ul>

123

<li> RGB - Red, Green, Blue </li>

124

<li> YUV - Luma, Blue Chrominance, Red Chrominance </li>

125

<li> HSV - Hue, Saturation, Value </li>

126

</ul>

127

128

129

130

131

<big>Camera.start</big> <ul>

132

opens, initializes, and starts capturing

133

<tt>Camera.start(): return None</tt>

134

Opens the camera device, attempts to initialize it, and begins recording images to a buffer. The camera must be started before any of the below functions can be used.

135

136

</ul>

137

138

139

140

<big>Camera.stop</big> <ul>

141

stops, uninitializes, and closes the camera

142

<tt>Camera.stop(): return None</tt>

143

Stops recording, uninitializes the camera, and closes it. Once a camera is stopped, the below functions cannot be used until it is started again.

144

145

</ul>

146

147

148

149

<big>Camera.get_controls</big> <ul>

150

gets current values of user controls

151

<tt>Camera.get_controls(): return (hflip = bool, vflip = bool, brightness)</tt>

152

If the camera supports it, get_controls will return the current settings for horizontal and vertical image flip as bools and brightness as an int. If unsupported, it will return the default values of (0, 0, 0). Note that the return values here may be different than those returned by set_controls, though these are more likely to be correct.

153

154

</ul>

155

156

157

158

<big>Camera.set_controls</big> <ul>

159

changes camera settings if supported by the camera

160

<tt>Camera.set_controls(hflip = bool, vflip = bool, brightness): return (hflip = bool, vflip = bool, brightness)</tt>

161

Allows you to change camera settings if the camera supports it. The return values will be the input values if the camera claims it succeeded or the values previously in use if not. Each argument is optional, and the desired one can be chosen by supplying the keyword, like hflip. Note that the actual settings being used by the camera may not be the same as those returned by set_controls.

162

163

</ul>

164

165

166

167

<big>Camera.get_size</big> <ul>

168

returns the dimensions of the images being recorded

169

<tt>Camera.get_size(): return (width, height)</tt>

170

Returns the current dimensions of the images being captured by the camera. This will return the actual size, which may be different than the one specified during initialization if the camera did not support that size.

171

172

</ul>

173

174

175

176

<big>Camera.query_image</big> <ul>

177

checks if a frame is ready

178

<tt>Camera.query_image(): return bool</tt>

179

If an image is ready to get, it returns true. Otherwise it returns false. Note that some webcams will always return False and will only queue a frame when called with a blocking function like get_image(). This is useful to separate the framerate of the game from that of the camera without having to use threading.

180

181

</ul>

182

183

184

185

<big>Camera.get_image</big> <ul>

186

captures an image as a Surface

187

<tt>Camera.get_image(Surface = None): return Surface</tt>

188

Pulls an image off of the buffer as an <tt>RGB</tt> Surface. It can optionally reuse an existing Surface to save time. The bit depth of the surface is either 24bits or the same as the optionally supplied Surface.

189

190

</ul>

191

192

193

194

<big>Camera.get_raw</big> <ul>

195

returns an unmodified image as a string

196

<tt>Camera.get_raw(): return string</tt>

197

Gets an image from a camera as a string in the native pixelformat of the camera. Useful for integration with other libraries.

198

199

</ul>

200

</ul>

201

</ul>

202

203

</body></html>

Older »