libmsx/vmem__rw_8h_source.html

// -*- coding: utf-8-unix -*-

/*

 * Copyright (c) 2021-2024 Daishi Mori (mori0091)

 *

 * This software is released under the MIT License.\n

 * See https://github.com/mori0091/libmsx/blob/main/LICENSE

 *

 * GitHub libmsx project\n

 * https://github.com/mori0091/libmsx

 */

#ifndef VMEM_RW_H_

#define VMEM_RW_H_


#include "vmem.h"


#include <stdbool.h>


// A part of building blocks for heterogeneous memory architechture, dedicated

// to VRAM access.


bool vmem_is_opened(void);


void vmem_open(vmemptr_t loc);


void vmem_close(void);


void vmem_dup(uint16_t offset, size_t len);


// internal functions


vmemptr_t vmem_ptr(void);


void vmem_skip(size_t len);


void vmem_write_chunk(const uint8_t * src, uint16_t len);


void vmem_read_chunk(uint8_t * dst, uint16_t len);


#endif // VMEM_RW_H_

vmemptr_t
uint32_t vmemptr_t
Type for VRAM address.
Definition vmem.h:42

vmem_dup
void vmem_dup(uint16_t offset, size_t len)
MSX Duplicate a byte sequence of VRAM starting from the specified offset to current position and late...

vmem_close
void vmem_close(void)
MSX Close VRAM accessor.

vmem_open
void vmem_open(vmemptr_t loc)
MSX Open VRAM accessor.

vmem_ptr
vmemptr_t vmem_ptr(void)
Get current position of VRAM accessor.

vmem_skip
void vmem_skip(size_t len)
Advance the current position of VRAM accessor.

vmem_write_chunk
void vmem_write_chunk(const uint8_t *src, uint16_t len)
Write a chunk to VRAM.

vmem_read_chunk
void vmem_read_chunk(uint8_t *dst, uint16_t len)
Read a chunk from VRAM.

vmem_is_opened
bool vmem_is_opened(void)
MSX Tests whether VRAM accessor is opened or not.

vmem.h
Data types and functions for VRAM access.