This class implements functions allowing to operate with resource data. More...

#include <Resource.h>

Public Types
using	Buffer = std::vector< uint8_t >
	Definition of a vector holding 8 bit values.

Static Public Member Functions
static bool	extractResource (const std::wstring &bundle, const std::wstring &name, const std::wstring &type, Buffer &buffer)
	Extracts specific resource information specified by the name and type of the resource.

static std::wstring	resourcePath (const std::wstring &name, const std::wstring &type, const std::wstring &bundle=std::wstring())
	Determines the path of a specified resource file.

static std::vector< std::wstring >	resourcePaths (const std::wstring &type, const std::wstring &directory=std::wstring(), const std::wstring &bundle=std::wstring())
	Determines the paths of all resource files with specified type.

Detailed Description

This class implements functions allowing to operate with resource data.

Member Typedef Documentation

Definition of a vector holding 8 bit values.

static bool Ocean::Platform::Apple::Resource::extractResource	(	const std::wstring &	bundle,
		const std::wstring &	name,
		const std::wstring &	type,
		Buffer &	buffer
	)

static

Extracts specific resource information specified by the name and type of the resource.

Parameters

bundle	The name of the bundle from which the resource will be extracted, an empty string to use the main bundle
name	The name of the resource
type	The type of the resource
buffer	The resulting resource information

static std::wstring Ocean::Platform::Apple::Resource::resourcePath	(	const std::wstring &	name,
		const std::wstring &	type,
		const std::wstring &	bundle = `std::wstring()`
	)

static

Determines the path of a specified resource file.

Parameters

name	The name of the resource
type	The type of the resource
bundle	The name of the bundle from which the resource will be extracted, an empty string to use the main bundle

static std::vector< std::wstring > Ocean::Platform::Apple::Resource::resourcePaths	(	const std::wstring &	type,
		const std::wstring &	directory = `std::wstring()`,
		const std::wstring &	bundle = `std::wstring()`
	)

static

Determines the paths of all resource files with specified type.

Parameters

type	The type of the resource
directory	Optional directory in which the resource files are located
bundle	The name of the bundle from which the resource will be extracted, an empty string to use the main bundle

The documentation for this class was generated from the following file: