Epok Engine

PSYQO SDK

psyqo::GTE::read

Function · 5 overloads

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Reads read as part of Geometry Transformation Engine math and register operations.

Belongs to
psyqo::GTE
Header
gte-registers.hh
Overloads
5

Declaration 1 of 5

template
Declaration
template <> [[deprecated("Use the reference version instead")]] inline void read<PseudoRegister::LV>(Vec3* ptr)

Reads read as part of Geometry Transformation Engine math and register operations.

ParameterTypeMeaning
ptrVec3 *Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "psyqo/gte-registers.hh"

// Assume these named values have been initialized with valid data:
// Vec3 * ptr

psyqo::GTE::read(ptr);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/gte-registers.hh:967

Declaration 2 of 5

template
Declaration
template <> inline void read<PseudoRegister::LV>(Vec3& ptr)

Reads read as part of Geometry Transformation Engine math and register operations.

ParameterTypeMeaning
ptrVec3 &Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "psyqo/gte-registers.hh"

// Assume these named values have been initialized with valid data:
// Vec3 & ptr

psyqo::GTE::read(ptr);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/gte-registers.hh:974

Declaration 3 of 5

static · template
Declaration
template <PseudoRegister reg, bool valid = false> [[deprecated("Use the reference version instead")]] static inline void read(Vec3* ptr)

Reads read as part of Geometry Transformation Engine math and register operations.

ParameterTypeMeaning
ptrVec3 *Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "psyqo/gte-registers.hh"

// Replace these template arguments with types or values accepted by the declaration:
// reg, valid

// Assume these named values have been initialized with valid data:
// Vec3 * ptr

psyqo::GTE::read<reg, valid>(ptr);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/gte-registers.hh:440

Declaration 4 of 5

static · template
Declaration
template <PseudoRegister reg, bool valid = false> static inline void read(Vec3& vec)

Reads read as part of Geometry Transformation Engine math and register operations.

ParameterTypeMeaning
vecVec3 &Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "psyqo/gte-registers.hh"

// Replace these template arguments with types or values accepted by the declaration:
// reg, valid

// Assume these named values have been initialized with valid data:
// Vec3 & vec

psyqo::GTE::read<reg, valid>(vec);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/gte-registers.hh:448

Declaration 5 of 5

static · template
Declaration
template <Register reg> static inline void read(uint32_t* ptr)

Read a 32-bits value from a GTE register to memory.

ParameterTypeMeaning
ptruint32_t *The pointer to the memory location to write to.

Returns: Nothing (void).

Example sketch

C++ example
#include "psyqo/gte-registers.hh"

// Replace these template arguments with types or values accepted by the declaration:
// reg

// Assume these named values have been initialized with valid data:
// uint32_t * ptr

psyqo::GTE::read<reg>(ptr);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/gte-registers.hh:396

Related members