ncer.h File Reference

Nintendo Cell Resource (.NCER) parser representing individual 2D sprite composite elements. More...

#include "common.h"
#include "ncgr.h"
#include "nclr.h"
#include "ppm.h"

Go to the source code of this file.

Data Structures
struct	NcerOam
	Represents a single Object Attribute Memory (OAM) hardware sub-sprite element. More...
struct	NcerCell
	A composite cell sprite made of multiple sub-sprite hardware OAM entries. More...
struct	NcerFile
	Unpacked representation of a complete .NCER resource. More...

Typedefs
typedef struct NcerOam	NcerOam
	Represents a single Object Attribute Memory (OAM) hardware sub-sprite element. More...
typedef struct NcerCell	NcerCell
	A composite cell sprite made of multiple sub-sprite hardware OAM entries. More...
typedef struct NcerFile	NcerFile
	Unpacked representation of a complete .NCER resource. More...

Functions
int	Ncer_Parse (const u8 *data, size_t size, NcerFile *out_ncer)
	Parses an unpacked .NCER cell layout block from raw bytes. More...
void	Ncer_Free (NcerFile *ncer)
	Deallocates all resources held inside an NcerFile structure. More...
void	Ncer_PrintInfo (const NcerFile *ncer)
	Prints parsed .NCER layout metadata to stdout. More...
void	Ncer_GetOamDrawOrigin (const NcerOam *oam, int *out_x, int *out_y)
	Calculates resolved horizontal and vertical origins for drawing an OAM. More...
int	Ncer_RenderCellToImage (const NcerFile *ncer, int cell_index, const NcgrImage *ncgr, const NclrPalette *palette, RgbaColor **out_pixels, int *out_width, int *out_height)
	Renders a composite cell into a raw RGBA pixels buffer. More...
int	Ncer_RenderCellToImageWithTileStride (const NcerFile *ncer, int cell_index, const NcgrImage *ncgr, const NclrPalette *palette, int tile_stride, RgbaColor **out_pixels, int *out_width, int *out_height)
	Renders a composite cell using specific tile character width stride formatting constraints. More...
void	Ncer_CellBounds (const NcerCell *cell, int *out_min_x, int *out_min_y, int *out_max_x, int *out_max_y)
	Computes bounding box limits for a cell. More...

Detailed Description

Nintendo Cell Resource (.NCER) parser representing individual 2D sprite composite elements.

Typedef Documentation

NcerCell

typedef struct NcerCell NcerCell

A composite cell sprite made of multiple sub-sprite hardware OAM entries.

NcerFile

typedef struct NcerFile NcerFile

Unpacked representation of a complete .NCER resource.

NcerOam

typedef struct NcerOam NcerOam

Represents a single Object Attribute Memory (OAM) hardware sub-sprite element.

Function Documentation

Ncer_CellBounds()

void Ncer_CellBounds	(	const NcerCell *	cell,
		int *	out_min_x,
		int *	out_min_y,
		int *	out_max_x,
		int *	out_max_y
	)

Computes bounding box limits for a cell.

Parameters

cell	Cell structure.
out_min_x	Minimum horizontal coordinate.
out_min_y	Minimum vertical coordinate.
out_max_x	Maximum horizontal coordinate.
out_max_y	Maximum vertical coordinate.

Ncer_Free()

void Ncer_Free

(

NcerFile *

ncer

)

Deallocates all resources held inside an NcerFile structure.

Parameters

ncer	Pointer to structure.

Ncer_GetOamDrawOrigin()

void Ncer_GetOamDrawOrigin	(	const NcerOam *	oam,
		int *	out_x,
		int *	out_y
	)

Calculates resolved horizontal and vertical origins for drawing an OAM.

Parameters

oam	Sub-sprite structure.
out_x	Output coordinate (horizontal).
out_y	Output coordinate (vertical).

Ncer_Parse()

int Ncer_Parse	(	const u8 *	data,
		size_t	size,
		NcerFile *	out_ncer
	)

Parses an unpacked .NCER cell layout block from raw bytes.

Parameters

data	Pointer to raw binary file data buffer.
size	Buffer size in bytes.
out_ncer	Destination structure.

Returns

0 on success; negative value on formatting or invalid signature errors.

Ncer_PrintInfo()

void Ncer_PrintInfo

(

const NcerFile *

ncer

)

Prints parsed .NCER layout metadata to stdout.

Parameters

ncer	Pointer to parsed NCER file.

Ncer_RenderCellToImage()

int Ncer_RenderCellToImage	(	const NcerFile *	ncer,
		int	cell_index,
		const NcgrImage *	ncgr,
		const NclrPalette *	palette,
		RgbaColor **	out_pixels,
		int *	out_width,
		int *	out_height
	)

Renders a composite cell into a raw RGBA pixels buffer.

Parameters

ncer	NCER resource.
cell_index	Index of the cell to draw.
ncgr	NCGR tile graphic resource.
palette	NCLR palette resource.
out_pixels	Output pointer to destination buffer, allocated inside this function.
out_width	Width of rendered cell.
out_height	Height of rendered cell.

Returns

0 on success; negative value on failure.

Ncer_RenderCellToImageWithTileStride()

int Ncer_RenderCellToImageWithTileStride	(	const NcerFile *	ncer,
		int	cell_index,
		const NcgrImage *	ncgr,
		const NclrPalette *	palette,
		int	tile_stride,
		RgbaColor **	out_pixels,
		int *	out_width,
		int *	out_height
	)

Renders a composite cell using specific tile character width stride formatting constraints.

Parameters

ncer	NCER resource.
cell_index	Index of the cell to draw.
ncgr	NCGR tile graphic resource.
palette	NCLR palette resource.
tile_stride	Width stride (in tiles) of NCGR image data.
out_pixels	Output pointer to destination buffer.
out_width	Width of rendered cell.
out_height	Height of rendered cell.

Returns

0 on success; negative value on failure.