loadGroundFromBuffer

Contents, API Reference, Interfaces, iPathEngine, loadGroundFromBuffer

iPathEngine::loadGroundFromBuffer()

Description

Constructs an iGround object from a data buffer containing a 3d ground mesh.

Syntax

std::unique_ptr<const iGround> loadGroundFromBuffer(const char* format, char const * data_Buffer, uint32_t data_BufferEntries, const char *const* options)

Parameters

	format		A C string specifying the format of the data in the buffer. Currently this can be "xml" or "tok" (lower case). This format string is not retained after the call and can subsequently be safely deleted.
	data_Buffer, data_BufferEntries		(See Passing Arrays.) The data buffer to load from.
	options		A set of attribute and value pairs that can be used to control some aspects of the ground loading process.

Return Value

If the data passed in is valid then a newly created Interface iGround object is returned.
Otherwise non-fatal errors will be reported relating to the validation failure and zero will be returned.

Remarks

Refer to Mesh Loading Options for a list of options that can be passed in to this method (but note that some of these options are only actually relevant to other situations, such as where an iMesh object is being constructed).

"xml" indicates that the buffer should be parsed as XML.
See XML Ground Meshes for details about the XML mesh format.

"tok" indicates that the buffer should be treated as tokenised XML.
Tokenised XML represents the same structure as XML but results in a smaller file size. See Tokenised XML for details.

C# Mapping

Ground loadGroundFromBuffer(string format, byte[] data, string[] options);

Java Mapping

Ground loadGroundFromBuffer(String format, byte[] data, String[] options);

next: iPathEngine::loadMeshFromBuffer()