CeresEngine::ResourceStreamDescriptor Struct Reference

A structure that describes the creation of a resource stream. More...

#include <CeresEngine/Resource/ResourceStream.hpp>

Public Attributes
bool	isSeekable: 1 = false
	If defined, indicates that returned stream must be seekable.
bool	allowCompression: 1 = true
	If defined, will indicate that the stream can be compressed by the implementation.
UInt64	sizeHint = 0
	A hint to the implementation on the size of the stream.

Detailed Description

A structure that describes the creation of a resource stream.

Member Data Documentation

allowCompression

bool CeresEngine::ResourceStreamDescriptor::allowCompression

If defined, will indicate that the stream can be compressed by the implementation.

isSeekable

bool CeresEngine::ResourceStreamDescriptor::isSeekable

If defined, indicates that returned stream must be seekable.

This can severely limit what the implementations can do. For instance, it may disable compression on the data.

sizeHint

UInt64 CeresEngine::ResourceStreamDescriptor::sizeHint = 0

A hint to the implementation on the size of the stream.

If defined, will allow the implementation to better optimize for the given size.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Resource/ResourceStream.hpp