Mercurial > sdl-ios-xcode
annotate include/SDL_rwops.h @ 1316:0781906086fa
*** empty log message ***
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 01 Feb 2006 08:24:32 +0000 |
| parents | c9b51268668f |
| children | 450721ad5436 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 9 |
| 10 This library is distributed in the hope that it will be useful, | |
| 11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 /* This file provides a general interface for SDL to read and write | |
| 24 data sources. It can easily be extended to files, memory, etc. | |
| 25 */ | |
| 26 | |
| 27 #ifndef _SDL_RWops_h | |
| 28 #define _SDL_RWops_h | |
| 29 | |
| 30 #include <stdio.h> | |
| 31 | |
| 32 #include "SDL_types.h" | |
| 33 | |
| 34 #include "begin_code.h" | |
| 35 /* Set up for C function definitions, even when using C++ */ | |
| 36 #ifdef __cplusplus | |
| 37 extern "C" { | |
| 38 #endif | |
| 39 | |
| 40 /* This is the read/write operation structure -- very basic */ | |
| 41 | |
| 42 typedef struct SDL_RWops { | |
| 43 /* Seek to 'offset' relative to whence, one of stdio's whence values: | |
| 44 SEEK_SET, SEEK_CUR, SEEK_END | |
| 45 Returns the final offset in the data source. | |
| 46 */ | |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
47 int (SDLCALL *seek)(struct SDL_RWops *context, int offset, int whence); |
| 0 | 48 |
| 49 /* Read up to 'num' objects each of size 'objsize' from the data | |
| 50 source to the area pointed at by 'ptr'. | |
| 51 Returns the number of objects read, or -1 if the read failed. | |
| 52 */ | |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
53 int (SDLCALL *read)(struct SDL_RWops *context, void *ptr, int size, int maxnum); |
| 0 | 54 |
| 55 /* Write exactly 'num' objects each of size 'objsize' from the area | |
| 56 pointed at by 'ptr' to data source. | |
| 57 Returns 'num', or -1 if the write failed. | |
| 58 */ | |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
59 int (SDLCALL *write)(struct SDL_RWops *context, const void *ptr, int size, int num); |
| 0 | 60 |
| 61 /* Close and free an allocated SDL_FSops structure */ | |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
62 int (SDLCALL *close)(struct SDL_RWops *context); |
| 0 | 63 |
| 64 Uint32 type; | |
| 65 union { | |
| 66 struct { | |
| 67 int autoclose; | |
| 68 FILE *fp; | |
| 69 } stdio; | |
| 70 struct { | |
| 71 Uint8 *base; | |
| 72 Uint8 *here; | |
| 73 Uint8 *stop; | |
| 74 } mem; | |
| 75 struct { | |
| 76 void *data1; | |
| 77 } unknown; | |
| 78 } hidden; | |
| 79 | |
| 80 } SDL_RWops; | |
| 81 | |
| 82 | |
| 83 /* Functions to create SDL_RWops structures from various data sources */ | |
| 84 | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
85 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFile(const char *file, const char *mode); |
| 0 | 86 |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
87 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFP(FILE *fp, int autoclose); |
| 0 | 88 |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
89 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromMem(void *mem, int size); |
|
764
974c0fb74bf8
Added function to create RWops from const memory: SDL_RWFromConstMem()
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
90 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromConstMem(const void *mem, int size); |
| 0 | 91 |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
92 extern DECLSPEC SDL_RWops * SDLCALL SDL_AllocRW(void); |
|
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
93 extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops *area); |
| 0 | 94 |
| 95 /* Macros to easily read and write from an SDL_RWops structure */ | |
| 96 #define SDL_RWseek(ctx, offset, whence) (ctx)->seek(ctx, offset, whence) | |
| 97 #define SDL_RWtell(ctx) (ctx)->seek(ctx, 0, SEEK_CUR) | |
| 98 #define SDL_RWread(ctx, ptr, size, n) (ctx)->read(ctx, ptr, size, n) | |
| 99 #define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n) | |
| 100 #define SDL_RWclose(ctx) (ctx)->close(ctx) | |
| 101 | |
| 102 | |
| 103 /* Ends C function definitions when using C++ */ | |
| 104 #ifdef __cplusplus | |
| 105 } | |
| 106 #endif | |
| 107 #include "close_code.h" | |
| 108 | |
| 109 #endif /* _SDL_RWops_h */ |