GoldFish Engine
Quite simple and lightweight game engine
Loading...
Searching...
No Matches
gf_resource.h File Reference

Resource. More...

#include <gf_pre.h>
#include <gf_macro.h>
#include <gf_type/resource.h>
#include <gf_type/core.h>
#include <stddef.h>

Go to the source code of this file.

Functions

gf_resource_tgf_resource_create (gf_engine_t *engine, const char *path)
 Create resource.
 
void gf_resource_destroy (gf_resource_t *resource)
 Destroy resource.
 
int gf_resource_get (gf_resource_t *resource, const char *name, void **data, size_t *size)
 Get data from resource.
 
void gf_resource_add (gf_resource_t *resource, const char *name, void *data, size_t size, int dir)
 Add data to resource.
 
void gf_resource_write (gf_resource_t *resource, const char *path, int progress)
 Write resource to file.
 

Detailed Description

Resource.

Definition in file gf_resource.h.

Function Documentation

◆ gf_resource_add()

void gf_resource_add ( gf_resource_t resource,
const char *  name,
void *  data,
size_t  size,
int  dir 
)
extern

Add data to resource.

Parameters
resourceResource
nameEntry name
dataData
sizeData size
dir0 if file, otherwise if directory

Definition at line 194 of file gf_resource.c.

◆ gf_resource_create()

gf_resource_t * gf_resource_create ( gf_engine_t engine,
const char *  path 
)
extern

Create resource.

Parameters
engineEngine instance
pathPath, use NULL to create empty resource
Returns
Resource

Definition at line 76 of file gf_resource.c.

◆ gf_resource_destroy()

void gf_resource_destroy ( gf_resource_t resource)
extern

Destroy resource.

Parameters
resourceResource

Definition at line 324 of file gf_resource.c.

◆ gf_resource_get()

int gf_resource_get ( gf_resource_t resource,
const char *  name,
void **  data,
size_t *  size 
)
extern

Get data from resource.

Parameters
resourceResource
nameEntry name
dataPointer to data result
sizePointer to size result
Returns
0 if successful, otherwise -1

Definition at line 183 of file gf_resource.c.

◆ gf_resource_write()

void gf_resource_write ( gf_resource_t resource,
const char *  path,
int  progress 
)
extern

Write resource to file.

Parameters
resourceResource
pathPath
progress0 to not show progress, otherwise show progress

Definition at line 242 of file gf_resource.c.