surface.h

Go to the documentation of this file.

 
#ifndef __LIBDRAGON_SURFACE_H
#define __LIBDRAGON_SURFACE_H
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Macro to create a texture format, combining the RDP native "fmt/size" tuple.
// This macro is used to genearte the #tex_format_t enums creating identifiers
// which are easy to convert back into RDP native fields.
#define _RDP_FORMAT_CODE(rdp_fmt, rdp_size)        (((rdp_fmt)<<2)|(rdp_size))
 
#define TEX_FORMAT_BITDEPTH(fmt)             (4 << ((fmt) & 0x3))
#define TEX_FORMAT_PIX2BYTES(fmt, pixels)    ((((pixels) << (((fmt) & 3) + 2)) + 7) >> 3)
#define TEX_FORMAT_BYTES2PIX(fmt, bytes)     (((bytes) << 1) >> ((fmt) & 3))
 
typedef enum {
    FMT_NONE   = 0,                        
 
    FMT_RGBA16 = _RDP_FORMAT_CODE(0, 2),   
    FMT_RGBA32 = _RDP_FORMAT_CODE(0, 3),   
    FMT_YUV16  = _RDP_FORMAT_CODE(1, 2),   
    FMT_CI4    = _RDP_FORMAT_CODE(2, 0),   
    FMT_CI8    = _RDP_FORMAT_CODE(2, 1),   
    FMT_IA4    = _RDP_FORMAT_CODE(3, 0),   
    FMT_IA8    = _RDP_FORMAT_CODE(3, 1),   
    FMT_IA16   = _RDP_FORMAT_CODE(3, 2),   
    FMT_I4     = _RDP_FORMAT_CODE(4, 0),   
    FMT_I8     = _RDP_FORMAT_CODE(4, 1),   
} tex_format_t;
 
const char* tex_format_name(tex_format_t fmt);
 
#define SURFACE_FLAGS_TEXFORMAT    0x001F   
#define SURFACE_FLAGS_OWNEDBUFFER  0x0020   
#define SURFACE_FLAGS_TEXINDEX     0x0F00   
 
typedef struct surface_s
{
    uint16_t flags;       
    uint16_t width;       
    uint16_t height;      
    uint16_t stride;      
    void *buffer;         
} surface_t;
 
inline surface_t surface_make(void *buffer, tex_format_t format, uint16_t width, uint16_t height, uint16_t stride) {
    return (surface_t){
        .flags = format,
        .width = width,
        .height = height,
        .stride = stride,
        .buffer = buffer,
    };
}
 
inline surface_t surface_make_linear(void *buffer, tex_format_t format, uint16_t width, uint16_t height) {
    return surface_make(buffer, format, width, height, TEX_FORMAT_PIX2BYTES(format, width));
}
 
surface_t surface_alloc(tex_format_t format, uint16_t width, uint16_t height);
 
surface_t surface_make_sub(surface_t *parent, 
    uint16_t x0, uint16_t y0, uint16_t width, uint16_t height);
 
void surface_free(surface_t *surface);
 
inline tex_format_t surface_get_format(const surface_t *surface)
{
    return (tex_format_t)(surface->flags & SURFACE_FLAGS_TEXFORMAT);
}
 
inline bool surface_has_owned_buffer(const surface_t *surface)
{
    return surface->buffer != NULL && surface->flags & SURFACE_FLAGS_OWNEDBUFFER;
}
 
inline surface_t surface_make_placeholder(int index, tex_format_t format, uint16_t width, uint16_t height, uint16_t stride) {
    return (surface_t){
        .flags = (uint16_t)(format | ((index & 0xF) << 8)),
        .width = width,
        .height = height,
        .stride = stride,
        .buffer = NULL,
    };
}
 
inline surface_t surface_make_placeholder_linear(int index, tex_format_t format, uint16_t width, uint16_t height) {
    return surface_make_placeholder(index, format, width, height, TEX_FORMAT_PIX2BYTES(format, width));
}
 
inline int surface_get_placeholder_index(const surface_t *surface)
{
    return (surface->flags >> 8) & 0xF;
}
 
 
#ifdef __cplusplus
}
#endif
 
#endif