#include <Mem.h>

Inheritance diagram for Mem:

# Static Public Member Functions
static void	copyBYTE (BYTE destination, const BYTE source, uint32 numberOfBYTES)
static void	copyHWORD (HWORD destination, const HWORD source, uint32 numberOfHWORDS)
static void	copyWORD (WORD destination, const WORD source, uint32 numberOfWORDS)
static void	combineBYTEs (BYTE destination, const BYTE source1, const BYTE *source2, uint32 numberOfBYTES)
static void	combineHWORDs (HWORD destination, const HWORD source1, const HWORD *source2, uint32 numberOfWORDS)
static void	combineWORDs (WORD destination, const WORD source1, const WORD *source2, uint32 numberOfWORDS)
static void	addOffsetToBYTE (BYTE destination, const BYTE source, uint32 numberOfBYTES, uint32 offset)
static void	addOffsetToHWORD (HWORD destination, const HWORD source, uint32 numberOfHWORDS, uint32 offset)
static void	addOffsetToWORD (WORD destination, const WORD source, uint32 numberOfWORDS, uint32 offset)
static void	clear (BYTE *destination, uint32 numberOfBYTES)

# Additional Inherited Members
Private Member Functions inherited from Object
void	constructor ()
	Class' constructor.
const void *	getVTable ()
bool	mutateTo (const void *targetClass)
Static Private Member Functions inherited from Object
static Object	getCast (void *object, ClassPointer targetClassGetClassMethod, ClassPointer baseClassGetClassMethod)
Private Attributes inherited from Object
void *	vTable
	Pointer to the class's virtual table.

# Detailed Description

Class Mem

Inherits from ListenerObject

Performs some memory copy and related procedures.

Definition at line 34 of file Mem.h.

# Member Function Documentation

# addOffsetToBYTE()

static void Mem::addOffsetToBYTE	(	BYTE *	destination,
		const BYTE *	source,
		uint32	numberOfBYTES,
		uint32	offset )

inlinestatic

Add the provided offset to the data from the provided memory source and place the results in the destination address onwards

Parameters

destination	Starting destination address
source	Starting source address
numberOfBYTES	Total number of BYTEs to combine
offset	Value to add to the data in the source address

Definition at line 171 of file Mem.h.

# addOffsetToHWORD()

static void Mem::addOffsetToHWORD	(	HWORD *	destination,
		const HWORD *	source,
		uint32	numberOfHWORDS,
		uint32	offset )

inlinestatic

Add the provided offset to the data from the provided memory source and place the results in the destination address onwards

Parameters

destination	Starting destination address
source	Starting source address
numberOfHWORDS	Total number of HWORDs to combine
offset	Value to add to the data in the source address

Definition at line 181 of file Mem.h.

# addOffsetToWORD()

static void Mem::addOffsetToWORD	(	WORD *	destination,
		const WORD *	source,
		uint32	numberOfWORDS,
		uint32	offset )

inlinestatic

Add the provided offset to the data from the provided memory source and place the results in the destination address onwards

Parameters

destination	Starting destination address
source	Starting source address
numberOfWORDS	Total number of WORDs to combine
offset	Value to add to the data in the source address

Definition at line 191 of file Mem.h.

# clear()

static void Mem::clear	(	BYTE *	destination,
		uint32	numberOfBYTES )

static

Write a determined number of zeros from the specified memory address onwards.

Parameters

destination	Starting address
numberOfBYTES	Total number of zeros to write

It doesn't need to be inlined since it is not used in performance critical places and it produces graphical glitches when inlined.

Definition at line 28 of file Mem.c.

# combineBYTEs()

static void Mem::combineBYTEs	(	BYTE *	destination,
		const BYTE *	source1,
		const BYTE *	source2,
		uint32	numberOfBYTES )

inlinestatic

Apply a bitwise OR operation to the specified number of BYTEs from the provided source addresses and place the results in the destination address onwards

Parameters

destination	Starting destination address
source1	Starting first source address
source2	Starting second source address
numberOfBYTES	Total number of BYTEs to combine

Definition at line 143 of file Mem.h.

# combineHWORDs()

static void Mem::combineHWORDs	(	HWORD *	destination,
		const HWORD *	source1,
		const HWORD *	source2,
		uint32	numberOfWORDS )

inlinestatic

Apply a bitwise OR operation to the specified number of HWORDs from the provided source addresses and place the results in the destination address onwards

Parameters

destination	Starting destination address
source1	Starting first source address
source2	Starting second source address
numberOfWORDS	Total number of HWORDs to combine

Definition at line 151 of file Mem.h.

# combineWORDs()

static void Mem::combineWORDs	(	WORD *	destination,
		const WORD *	source1,
		const WORD *	source2,
		uint32	numberOfWORDS )

inlinestatic

Apply a bitwise OR operation to the specified number of WORDs from the provided source addresses and place the results in the destination address onwards

Parameters

destination	Starting destination address
source1	Starting first source address
source2	Starting second source address
numberOfWORDS	Total number of WORDs to combine

Definition at line 161 of file Mem.h.

# copyBYTE()

static void Mem::copyBYTE	(	BYTE *	destination,
		const BYTE *	source,
		uint32	numberOfBYTES )

inlinestatic

Copy a block of BYTEs from the source memory address to the destination memory address

Parameters

destination	Starting destination address
source	Starting source address
numberOfBYTES	Total number of BYTEs to copy

# copyHWORD()

static void Mem::copyHWORD	(	HWORD *	destination,
		const HWORD *	source,
		uint32	numberOfHWORDS )

inlinestatic

Copy a block of HWORDs from the source memory address to the destination memory address

Parameters

destination	Starting destination address
source	Starting source address
numberOfHWORDS	Total number of HWORDs to copy

Definition at line 123 of file Mem.h.

# copyWORD()

static void Mem::copyWORD	(	WORD *	destination,
		const WORD *	source,
		uint32	numberOfWORDS )

inlinestatic

Copy a block of WORDs from the source memory address to the destination memory address

Parameters

destination	Starting destination address
source	Starting source address
numberOfWORDS	Total number of WORDs to copy

Definition at line 133 of file Mem.h.

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

VUEngine-Core/source/Misc/Memory/Mem.h
VUEngine-Core/source/Misc/Memory/Mem.c

Introduction

Setup

Basics

Language

User Guide

API

Tutorial

Mem Class Reference

# Static Public Member Functions

# Additional Inherited Members

# Detailed Description

# Member Function Documentation

# addOffsetToBYTE()

# addOffsetToHWORD()

# addOffsetToWORD()

# clear()

# combineBYTEs()

# combineHWORDs()

# combineWORDs()

# copyBYTE()

# copyHWORD()

# copyWORD()