Pulsar  3d3a057
bfgrp.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Group init
4  */
5 #pragma once
6 
8 #include <pulsar/bfgrp/bfgrp_internal.h>
9 
10 /// Group method categories
11 typedef enum {
12  PLSR_BFGRPCategoryType_Init = 0,
13  PLSR_BFGRPCategoryType_Location,
15 
16 /// Group 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 locationTable;
26 } PLSR_BFGRP;
27 
28 /// @copydoc plsrArchiveOpen
29 PLSR_RC plsrBFGRPOpen(const char* path, PLSR_BFGRP* out);
30 
31 /// @copydoc plsrArchiveOpenInside
32 PLSR_RC plsrBFGRPOpenInside(const PLSR_Archive* ar, u32 offset, PLSR_BFGRP* out);
33 
34 /// @copydoc plsrArchiveClose
35 void plsrBFGRPClose(PLSR_BFGRP* bfgrp);
Archive section.
Definition: archive.h:34
Common archive header information.
Definition: archive.h:22
Archive container interface.
Group file.
Definition: bfgrp.h:17
void plsrBFGRPClose(PLSR_BFGRP *bfgrp)
Close archive, releasing resources if applicable.
PLSR_RC plsrBFGRPOpenInside(const PLSR_Archive *ar, u32 offset, PLSR_BFGRP *out)
Open from inside another archive at specified offset.
Archive file.
Definition: archive.h:75
PLSR_BFGRPCategoryType
Group method categories.
Definition: bfgrp.h:11
u32 PLSR_RC
Result code returned by Pulsar functions.
Definition: types.h:73
PLSR_RC plsrBFGRPOpen(const char *path, PLSR_BFGRP *out)
Open from a file at specified path.
Archive table (entry list)
Definition: archive.h:45