Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members
Classes | Enumerations | Functions | Variables
resource Namespace Reference

In this namespace can be found resource management classes like ResoureceManager, Resource and so on. More...

Classes

class  Buffer
class  DataStream
class  FileDataStream
 Subclass of DataStream for handling data from files. More...
struct  LoadEvent
 Struct containing information about a load event. More...
class  LoadEventReceiver
class  MemoryDataStream
 Subclass of DataStream for handling data from chunks of memory. More...
struct  PixelFormatDescription
 A record that describes a pixel format in detail. More...
class  PixelUtil
class  Resource
class  ResourceDriver
struct  ResourceEvent
 Struct containing information about a Resource event. More...
class  ResourceEventReceiver
class  ResourceFactory
class  ResourceManager
class  Serializer

Enumerations

enum  BufferLocking { BL_NORMAL, BL_DISCARD, BL_READ_ONLY, BL_NO_OVERWRITE }
 Locking options. More...
enum  BufferUsage {
  BU_STATIC = 1, BU_DYNAMIC = 2, BU_WRITE_ONLY = 4, BU_STATIC_WRITE_ONLY = 5,
  BU_DYNAMIC_WRITE_ONLY = 6, BU_DISCARDABLE = 8, BU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14
}
 Enum describing buffer usage; not mutually exclusive. More...
enum  PixelComponentType {
  PCT_BYTE, PCT_SHORT, PCT_FLOAT16, PCT_FLOAT32,
  PCT_COUNT
}
 Pixel component format. More...
enum  PixelFormat {
  PF_UNKNOWN = 0, PF_L8 = 1, PF_BYTE_L = PF_L8, PF_L16 = 2,
  PF_SHORT_L = PF_L16, PF_A8 = 3, PF_BYTE_A = PF_A8, PF_A4L4 = 4,
  PF_BYTE_LA = 5, PF_R5G6B5 = 6, PF_B5G6R5 = 7, PF_R3G3B2 = 31,
  PF_A4R4G4B4 = 8, PF_A1R5G5B5 = 9, PF_R8G8B8 = 10, PF_B8G8R8 = 11,
  PF_A8R8G8B8 = 12, PF_A8B8G8R8 = 13, PF_B8G8R8A8 = 14, PF_R8G8B8A8 = 28,
  PF_X8R8G8B8 = 26, PF_X8B8G8R8 = 27, PF_BYTE_RGB = PF_R8G8B8, PF_BYTE_BGR = PF_B8G8R8,
  PF_BYTE_BGRA = PF_B8G8R8A8, PF_BYTE_RGBA = PF_R8G8B8A8, PF_A2R10G10B10 = 15, PF_A2B10G10R10 = 16,
  PF_DXT1 = 17, PF_DXT2 = 18, PF_DXT3 = 19, PF_DXT4 = 20,
  PF_DXT5 = 21, PF_FLOAT16_R = 32, PF_FLOAT16_RGB = 22, PF_FLOAT16_RGBA = 23,
  PF_FLOAT32_R = 33, PF_FLOAT32_RGB = 24, PF_FLOAT32_RGBA = 25, PF_FLOAT16_GR = 35,
  PF_FLOAT32_GR = 36, PF_DEPTH = 29, PF_SHORT_RGBA = 30, PF_SHORT_GR = 34,
  PF_SHORT_RGB = 37, PF_PVRTC_RGB2 = 38, PF_PVRTC_RGBA2 = 39, PF_PVRTC_RGB4 = 40,
  PF_PVRTC_RGBA4 = 41, PF_COUNT = 42
}
enum  PixelFormatFlags {
  PFF_HASALPHA = 0x00000001, PFF_COMPRESSED = 0x00000002, PFF_FLOAT = 0x00000004, PFF_DEPTH = 0x00000008,
  PFF_NATIVEENDIAN = 0x00000010, PFF_LUMINANCE = 0x00000020
}
 Flags defining some on/off properties of pixel formats. More...
enum  ResourceState {
  RS_UNDEFINED, RS_UNLOADED, RS_LOADING, RS_LOADED,
  RS_UNLOADING
}
enum  ResourceType {
  RT_UNDEFINED, RT_RESOURCE_SCENE, RT_RESOURCE_FONT, RT_RESOURCE_MESH_DATA,
  RT_RESOURCE_RENDER_MATERIAL, RT_RESOURCE_TEXTURE, RT_RESOURCE_SHADER, RT_RESOURCE_SOUND_DATA,
  RT_RESOURCE_BODY_DATA, RT_RESOURCE_PHYSICS_MATERIAL, RT_RESOURCE_SCRIPT, RT_COUNT
}
 Resource type. More...

Functions

render::Color ENGINE_PUBLIC_EXPORT parseColor (std::string &params)
core::quaternion
ENGINE_PUBLIC_EXPORT 
parseQuaternion (std::string &params)
core::vector3d ENGINE_PUBLIC_EXPORT parseVector3d (std::string &params)

Variables

const u32 CHUNK_OVERHEAD_SIZE = sizeof(u16) + sizeof(u32)
 Chunk overhead = ID + size.
const u16 HEADER_CHUNK_ID = 0x1000

Detailed Description

In this namespace can be found resource management classes like ResoureceManager, Resource and so on.


Enumeration Type Documentation

Locking options.

Enumerator:
BL_NORMAL 
BL_DISCARD 

Normal mode, ie allows read/write and contents are preserved.

BL_READ_ONLY 

Discards the entire buffer while locking; Only allowed with the BU_DYNAMIC flag.

BL_NO_OVERWRITE 

Lock the buffer for reading only. Not allowed with the BU_WRITE_ONLY flag. Mandatory on static buffers.

As BL_NORMAL, except the application do not overwrite any region of the buffer which has already been used in this frame.

Enum describing buffer usage; not mutually exclusive.

Enumerator:
BU_STATIC 
BU_DYNAMIC 

Static buffer which the application rarely modifies once created.

BU_WRITE_ONLY 

Dynamic buffer which the application fairly often modifies once created.

BU_STATIC_WRITE_ONLY 

The application will never read the contents of the buffer back, it will only ever write data.

BU_DYNAMIC_WRITE_ONLY 

Combination of BU_STATIC and BU_WRITE_ONLY.

BU_DISCARDABLE 

Combination of BU_DYNAMIC and BU_WRITE_ONLY.

BU_DYNAMIC_WRITE_ONLY_DISCARDABLE 

Discardable buffer which the application will be refilling the contents of the buffer regularly (not just updating, but generating the contents from scratch)

Pixel component format.

Enumerator:
PCT_BYTE 
PCT_SHORT 

Byte per component (8 bit fixed 0.0..1.0).

PCT_FLOAT16 

Short per component (16 bit fixed 0.0..1.0).

PCT_FLOAT32 

16 bit float per component.

PCT_COUNT 

32 bit float per component.

Number of pixel types.

Enumerator:
PF_UNKNOWN 
PF_L8 

Unknown pixel format.

PF_BYTE_L 

8-bit pixel format, all bits luminace.

PF_L16 
PF_SHORT_L 

16-bit pixel format, all bits luminace.

PF_A8 
PF_BYTE_A 

8-bit pixel format, all bits alpha.

PF_A4L4 
PF_BYTE_LA 

8-bit pixel format, 4 bits alpha, 4 bits luminance.

PF_R5G6B5 

2 byte pixel format, 1 byte luminance, 1 byte alpha

PF_B5G6R5 

16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.

PF_R3G3B2 

16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.

PF_A4R4G4B4 

8-bit pixel format, 2 bits blue, 3 bits green, 3 bits red.

PF_A1R5G5B5 

16-bit pixel format, 4 bits for alpha, red, green and blue.

PF_R8G8B8 

16-bit pixel format, 5 bits for blue, green, red and 1 for alpha.

PF_B8G8R8 

24-bit pixel format, 8 bits for red, green and blue.

PF_A8R8G8B8 

24-bit pixel format, 8 bits for blue, green and red.

PF_A8B8G8R8 

32-bit pixel format, 8 bits for alpha, red, green and blue.

PF_B8G8R8A8 

32-bit pixel format, 8 bits for blue, green, red and alpha.

PF_R8G8B8A8 

32-bit pixel format, 8 bits for blue, green, red and alpha.

PF_X8R8G8B8 

32-bit pixel format, 8 bits for red, green, blue and alpha.

PF_X8B8G8R8 

32-bit pixel format, 8 bits for red, 8 bits for green, 8 bits for blue, like PF_A8R8G8B8, but alpha will get discarded

PF_BYTE_RGB 

32-bit pixel format, 8 bits for blue, 8 bits for green, 8 bits for red, like PF_A8B8G8R8, but alpha will get discarded

PF_BYTE_BGR 

3 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue

PF_BYTE_BGRA 

3 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red

PF_BYTE_RGBA 

4 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red and one byte for alpha

PF_A2R10G10B10 

4 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue, and one byte for alpha

PF_A2B10G10R10 

32-bit pixel format, 2 bits for alpha, 10 bits for red, green and blue.

PF_DXT1 

32-bit pixel format, 10 bits for blue, green and red, 2 bits for alpha.

PF_DXT2 

DDS (DirectDraw Surface) DXT1 format.

PF_DXT3 

DDS (DirectDraw Surface) DXT2 format.

PF_DXT4 

DDS (DirectDraw Surface) DXT3 format.

PF_DXT5 

DDS (DirectDraw Surface) DXT4 format.

PF_FLOAT16_R 

DDS (DirectDraw Surface) DXT5 format.

PF_FLOAT16_RGB 

16-bit pixel format, 16 bits (float) for red

PF_FLOAT16_RGBA 

48-bit pixel format, 16 bits (float) for red, 16 bits (float) for green, 16 bits (float) for blue

PF_FLOAT32_R 

64-bit pixel format, 16 bits (float) for red, 16 bits (float) for green, 16 bits (float) for blue, 16 bits (float) for alpha

PF_FLOAT32_RGB 

16-bit pixel format, 16 bits (float) for red

PF_FLOAT32_RGBA 

96-bit pixel format, 32 bits (float) for red, 32 bits (float) for green, 32 bits (float) for blue

PF_FLOAT16_GR 

128-bit pixel format, 32 bits (float) for red, 32 bits (float) for green, 32 bits (float) for blue, 32 bits (float) for alpha

PF_FLOAT32_GR 

32-bit, 2-channel s10e5 floating point pixel format, 16-bit green, 16-bit red

PF_DEPTH 

64-bit, 2-channel floating point pixel format, 32-bit green, 32-bit red

PF_SHORT_RGBA 

Depth texture format.

PF_SHORT_GR 

64-bit pixel format, 16 bits for red, green, blue and alpha

PF_SHORT_RGB 

32-bit pixel format, 16-bit green, 16-bit red

PF_PVRTC_RGB2 

48-bit pixel format, 16 bits for red, green and blue

PF_PVRTC_RGBA2 

PVRTC (PowerVR) RGB 2 bpp.

PF_PVRTC_RGB4 

PVRTC (PowerVR) RGBA 2 bpp.

PF_PVRTC_RGBA4 

PVRTC (PowerVR) RGB 4 bpp.

PF_COUNT 

PVRTC (PowerVR) RGBA 4 bpp.

Flags defining some on/off properties of pixel formats.

Enumerator:
PFF_HASALPHA 
PFF_COMPRESSED 
PFF_FLOAT 
PFF_DEPTH 
PFF_NATIVEENDIAN 
PFF_LUMINANCE 
Enumerator:
RS_UNDEFINED 
RS_UNLOADED 
RS_LOADING 
RS_LOADED 
RS_UNLOADING 

Resource type.

Enumerator:
RT_UNDEFINED 
RT_RESOURCE_SCENE 
RT_RESOURCE_FONT 
RT_RESOURCE_MESH_DATA 
RT_RESOURCE_RENDER_MATERIAL 
RT_RESOURCE_TEXTURE 
RT_RESOURCE_SHADER 
RT_RESOURCE_SOUND_DATA 
RT_RESOURCE_BODY_DATA 
RT_RESOURCE_PHYSICS_MATERIAL 
RT_RESOURCE_SCRIPT 
RT_COUNT 

Function Documentation

render::Color resource::parseColor ( std::string &  params) [inline]
core::quaternion resource::parseQuaternion ( std::string &  params) [inline]
core::vector3d resource::parseVector3d ( std::string &  params) [inline]

Variable Documentation

const u32 resource::CHUNK_OVERHEAD_SIZE = sizeof(u16) + sizeof(u32)

Chunk overhead = ID + size.


The KG Game Engine
The KG Game Engine Documentation © 2006-2011 by Kat'Oun. Generated on Sat Jul 2 2011 00:50:09 by Doxygen (1.7.4)