Struct ApplicationBuilder

pub struct ApplicationBuilder { /* private fields */ }

Implementations

impl ApplicationBuilder

pub fn name(&mut self, name: &str) -> &mut Self

Set the name of the application.

Is used in comments when exporting to a dasm source using crate::generator::DasmGenerator

use c64_assembler::builder::ApplicationBuilder;
let application = ApplicationBuilder::default()
    .name("My application")
    .build();

pub fn entry_point(&mut self, entry_point: Address) -> &mut Self

Change the entry point of the application.

NOTE: When not set to 0x0800 crate::builder::instruction::InstructionBuilder::add_basic_header cannot be used.

Default entry point is set to 0x0800.

use c64_assembler::builder::ApplicationBuilder;
let application = ApplicationBuilder::default()
    .entry_point(0x0800)
    .build();

pub fn define_address(&mut self, name: &str, address: Address) -> &mut Self

Define a static address.

When using instructions each address needs to be accessed by its name. This function allows to add a new named address. There is no difference between zeropaged and regular addresses. When building the instruction stream the actual address will decide which opcode is used.

use c64_assembler::builder::ApplicationBuilder;
let application = ApplicationBuilder::default()
    .define_address("VIC_BORDER_COLOR", 0xD020)
    .define_address("ZEROPAGE_FE", 0xFE)
    .build();

pub fn include_vic2_defines(&mut self) -> &mut Self

Add the address defines useful when using the VIC2.

Address Name	Physical Address	Description
VIC2_BASE	0xD000	Base address for VIC registers
VIC2_SPRITE_0_X	0xD000	X coordinate of sprite 0
VIC2_SPRITE_0_Y	0xD001	Y coordinate of sprite 0
VIC2_SPRITE_1_X	0xD002	X coordinate of sprite 1
VIC2_SPRITE_1_Y	0xD003	Y coordinate of sprite 1
VIC2_SPRITE_2_X	0xD004	X coordinate of sprite 2
VIC2_SPRITE_2_Y	0xD005	Y coordinate of sprite 2
VIC2_SPRITE_3_X	0xD006	X coordinate of sprite 3
VIC2_SPRITE_3_Y	0xD007	Y coordinate of sprite 3
VIC2_SPRITE_4_X	0xD008	X coordinate of sprite 4
VIC2_SPRITE_4_Y	0xD009	Y coordinate of sprite 4
VIC2_SPRITE_5_X	0xD00A	X coordinate of sprite 5
VIC2_SPRITE_5_Y	0xD00B	Y coordinate of sprite 5
VIC2_SPRITE_6_X	0xD00C	X coordinate of sprite 6
VIC2_SPRITE_6_Y	0xD00D	Y coordinate of sprite 6
VIC2_SPRITE_7_X	0xD00E	X coordinate of sprite 7
VIC2_SPRITE_7_Y	0xD00F	Y coordinate of sprite 7
VIC2_SPRITE_X_MSB	0xD010	Most significant bit for sprite X coordinates
VIC2_CONTROL_1	0xD011	Screen control register 1
VIC2_RASTER	0xD012	Raster line position
VIC2_LIGHT_PEN_X	0xD013	Light pen X position
VIC2_LIGHT_PEN_Y	0xD014	Light pen Y position
VIC2_SPRITE_ENABLE	0xD015	Enables sprites
VIC2_CONTROL_2	0xD016	Screen control register 2
VIC2_SPRITE_EXPAND_X	0xD017	Expands sprites horizontally
VIC2_MEMORY_SETUP	0xD018	VIC memory setup
VIC2_IRQ_STATUS	0xD019	Interrupt request status
VIC2_IRQ_ENABLE	0xD01A	Interrupt request enable
VIC2_SPRITE_PRIORITY	0xD01B	Sprite priority over background
VIC2_SPRITE_MULTICOLOR	0xD01C	Enables multicolor mode for sprites
VIC2_SPRITE_EXPAND_Y	0xD01D	Expands sprites vertically
VIC2_SPRITE_COLLISION	0xD01E	Sprite-to-sprite collision detection
VIC2_SPRITE_BG_COLLISION	0xD01F	Sprite-to-background collision detection
VIC2_BORDER_COLOR	0xD020	Border color
VIC2_BACKGROUND_COLOR	0xD021	Background color
VIC2_BACKGROUND_COLOR_0	0xD021	Background color 0
VIC2_BACKGROUND_COLOR_1	0xD022	Background color 1
VIC2_BACKGROUND_COLOR_2	0xD023	Background color 2
VIC2_BACKGROUND_COLOR_3	0xD024	Background color 3
VIC2_SPRITE_MULTICOLOR_0	0xD025	Multicolor mode color 0 for sprites
VIC2_SPRITE_MULTICOLOR_1	0xD026	Multicolor mode color 1 for sprites
VIC2_SPRITE_0_COLOR	0xD027	Color of sprite 0
VIC2_SPRITE_1_COLOR	0xD028	Color of sprite 1
VIC2_SPRITE_2_COLOR	0xD029	Color of sprite 2
VIC2_SPRITE_3_COLOR	0xD02A	Color of sprite 3
VIC2_SPRITE_4_COLOR	0xD02B	Color of sprite 4
VIC2_SPRITE_5_COLOR	0xD02C	Color of sprite 5
VIC2_SPRITE_6_COLOR	0xD02D	Color of sprite 6
VIC2_SPRITE_7_COLOR	0xD02E	Color of sprite 7

use c64_assembler::builder::ApplicationBuilder;
let application = ApplicationBuilder::default()
    .include_vic2_defines()
    .build();

pub fn include_sid_defines(&mut self) -> &mut Self

Add the address defines useful when using the SID.

Address Name	Physical Address	Description
SID_BASE	0xD400	Base address for SID registers
SID_VOICE_1_FREQ_LO	0xD400	Voice 1 frequency (low byte)
SID_VOICE_1_FREQ_HI	0xD401	Voice 1 frequency (high byte)
SID_VOICE_1_PW_LO	0xD402	Voice 1 pulse width (low byte)
SID_VOICE_1_PW_HI	0xD403	Voice 1 pulse width (high byte)
SID_VOICE_1_CTRL	0xD404	Voice 1 control register
SID_VOICE_1_AD	0xD405	Voice 1 attack/decay settings
SID_VOICE_1_SR	0xD406	Voice 1 sustain/release settings
SID_VOICE_2_FREQ_LO	0xD407	Voice 2 frequency (low byte)
SID_VOICE_2_FREQ_HI	0xD408	Voice 2 frequency (high byte)
SID_VOICE_2_PW_LO	0xD409	Voice 2 pulse width (low byte)
SID_VOICE_2_PW_HI	0xD40A	Voice 2 pulse width (high byte)
SID_VOICE_2_CTRL	0xD40B	Voice 2 control register
SID_VOICE_2_AD	0xD40C	Voice 2 attack/decay settings
SID_VOICE_2_SR	0xD40D	Voice 2 sustain/release settings
SID_VOICE_3_FREQ_LO	0xD40E	Voice 3 frequency (low byte)
SID_VOICE_3_FREQ_HI	0xD40F	Voice 3 frequency (high byte)
SID_VOICE_3_PW_LO	0xD410	Voice 3 pulse width (low byte)
SID_VOICE_3_PW_HI	0xD411	Voice 3 pulse width (high byte)
SID_VOICE_3_CTRL	0xD412	Voice 3 control register
SID_VOICE_3_AD	0xD413	Voice 3 attack/decay settings
SID_VOICE_3_SR	0xD414	Voice 3 sustain/release settings
SID_FILTER_CUTOFF_LO	0xD415	Filter cutoff frequency (low byte)
SID_FILTER_CUTOFF_HI	0xD416	Filter cutoff frequency (high byte)
SID_FILTER_CTRL	0xD417	Filter control register
SID_VOLUME_FC	0xD418	Volume and filter control
SID_POT_X	0xD419	Paddle X position (read)
SID_POT_Y	0xD41A	Paddle Y position (read)
SID_OSC3_RANDOM	0xD41B	Oscillator 3 output/random number generator
SID_ENV3	0xD41C	Envelope generator for voice 3 (read)

use c64_assembler::builder::ApplicationBuilder;
let application = ApplicationBuilder::default()
    .include_sid_defines()
    .build();

pub fn module(&mut self, module: Module) -> &mut Self

pub fn build(&mut self) -> AssemblerResult<Application>

Build the application

Trait Implementations

impl Clone for ApplicationBuilder

fn clone(&self) -> ApplicationBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ApplicationBuilder

fn default() -> Self

Returns the “default value” for a type.