API exported by pygame.rwobject — pygame v2.6.1 documentation

##### pygame documentation

Pygame Home || Help Contents || Reference Index

Most useful stuff: Color | display | draw | event | font | image | key | locals | mixer | mouse | Rect | Surface | time | music | pygame

Advanced stuff: cursors | joystick | mask | sprite | transform | BufferProxy | freetype | gfxdraw | midi | PixelArray | pixelcopy | sndarray | surfarray | math

Other: camera | controller | examples | fastevent | scrap | tests | touch | version

## src_c/rwobject.c

This extension module implements functions for wrapping a Python file like object in a `SDL_RWops` struct for SDL file access.

Header file: src_c/include/pygame.h

SDL_RWops *pgRWops_FromObject(PyObject *obj, char **extptr)

  Return a SDL_RWops struct filled to access obj. If obj is a string then let SDL open the file it names. Otherwise, if obj is a Python file-like object then use its `read`, `write`, `seek`, `tell`, and `close` methods. If threads are available, the Python GIL is acquired before calling any of the obj methods. If you want to see the file extension, you can pass in a char double pointer that will be populated to a dynamically allocated string or NULL. Caller is responsible for freeing the extension string. It is safe to pass NULL if you don't care about the file extension. On error raise a Python exception and return `NULL`. If NULL is returned, the extptr will not be populated with dynamic memory, it is not necessary to free in that error handling.

SDL_RWops *pgRWops_FromFileObject(PyObject *obj)

  Return a SDL_RWops struct filled to access the Python file-like object obj. Uses its `read`, `write`, `seek`, `tell`, and `close` methods. If threads are available, the Python GIL is acquired before calling any of the obj methods. On error raise a Python exception and return `NULL`.

int pgRWops_IsFileObject(SDL_RWops *rw)

  Return true if rw is a Python file-like object wrapper returned by `pgRWops_FromObject()` or `pgRWops_FromFileObject()`.

int pgRWops_ReleaseObject(SDL_RWops *context)

  Free a SDL_RWops struct. If it is attached to a Python file-like object, decrement its refcount. Otherwise, close the file handle. Return 0 on success. On error, raise a Python exception and return a negative value.

PyObject *pg_EncodeFilePath(PyObject *obj, PyObject *eclass)

  Return the file path obj as a byte string properly encoded for the OS. Null bytes are forbidden in the encoded file path. On error raise a Python exception and return `NULL`, using eclass as the exception type if it is not `NULL`. If obj is `NULL` assume an exception was already raised and pass it on.

PyObject *pg_EncodeString(PyObject *obj, const char *encoding, const char *errors, PyObject *eclass)

  Return string obj as an encoded byte string. The C string arguments encoding and errors are the same as for `PyUnicode_AsEncodedString()`. On error raise a Python exception and return `NULL`, using eclass as the exception type if it is not `NULL`. If obj is `NULL` assume an exception was already raised and pass it on.

Edit on GitHub