Pulsar  3d3a057
bfwar.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Wave archive init
4  */
5 #pragma once
6 
8 #include <pulsar/bfwar/bfwar_internal.h>
9 
10 /// Wave archive method categories
11 typedef enum {
12  PLSR_BFWARCategoryType_Init = 0,
13  PLSR_BFWARCategoryType_File,
15 
16 /// Wave archive file
17 typedef struct {
18  PLSR_Archive ar;
19 
20  PLSR_ArchiveHeaderInfo headerInfo;
21 
22  PLSR_ArchiveSection infoSection;
23  PLSR_ArchiveSection fileSection;
24 
25  PLSR_ArchiveTable fileTable;
26 } PLSR_BFWAR;
27 
28 /// @copydoc plsrArchiveOpen
29 PLSR_RC plsrBFWAROpen(const char* path, PLSR_BFWAR* out);
30 
31 /// @copydoc plsrArchiveOpenInside
32 PLSR_RC plsrBFWAROpenInside(const PLSR_Archive* ar, u32 offset, PLSR_BFWAR* out);
33 
34 /// @copydoc plsrArchiveClose
35 void plsrBFWARClose(PLSR_BFWAR* bfwar);
Archive section.
Definition: archive.h:34
Common archive header information.
Definition: archive.h:22
Archive container interface.
Wave archive file.
Definition: bfwar.h:17
PLSR_RC plsrBFWAROpen(const char *path, PLSR_BFWAR *out)
Open from a file at specified path.
Archive file.
Definition: archive.h:75
void plsrBFWARClose(PLSR_BFWAR *bfwar)
Close archive, releasing resources if applicable.
PLSR_BFWARCategoryType
Wave archive method categories.
Definition: bfwar.h:11
PLSR_RC plsrBFWAROpenInside(const PLSR_Archive *ar, u32 offset, PLSR_BFWAR *out)
Open from inside another archive at specified offset.
u32 PLSR_RC
Result code returned by Pulsar functions.
Definition: types.h:73
Archive table (entry list)
Definition: archive.h:45