MXVK Vulkan Framework 0.24.0
C++20 Vulkan rendering framework for practical 2D and 3D application development with SDL3.
Loading...
Searching...
No Matches
Arguments Struct Reference

Plain data structure returned by proc_args() with all common libmx2 CLI options. More...

#include <mxvk/include/mxvk/argz.hpp>

Public Attributes

bool benchmark = false
 Enable application benchmark mode (--benchmark).
bool binary = false
 Use binary glyphs only (--binary).
int camera_index = 0
 Optional camera index.
std::string color
 Optional rain RGB tint (--color).
std::string crf
 Optional CRF value (--crf).
bool disable_mipmap = false
 Disable mipmap generation and selection (--disable-mipmap).
bool disable_sound = false
 Disable application background music (--disable-sound).
bool enable_crt = false
 Enable CRT post-processing at startup (--enable-crt).
bool enable_screenshot = false
 Enable F10 screenshot capture (--enable-screenshot).
bool enable_vsync = false
 Enable FIFO present mode / v-sync (--enable-vsync).
std::string encodeCodec
 Optional encoder codec policy/name (--encode-codec).
std::string encodePreset
 Optional encoder preset (--encode-preset).
bool encodeRealtime = false
 Enable low-latency encoder settings (--encode-realtime).
std::string encodeTune
 Optional encoder tune (--encode-tune).
std::string executable_name = "mxvk"
 Executable basename derived from argv[0].
bool fast = false
 Whether fast mode was requested (--fast).
std::string filename
 Optional input filename (--filename).
std::string font_path
 Optional font file path (--font-path).
int font_size = 22
 Matrix rain font size in pixels (--font-size).
double fps = 0.0
 Optional FPS override (--fps); non-positive means unspecified.
std::string fragmentPath
 Optional fragment shader SPV path (--fragment).
FramebufferDimensions framebuffer
 Software framebuffer size requested by --framebuffer.
bool framebufferSpecified = false
 Whether --framebuffer was provided.
bool fullscreen = false
 Whether fullscreen mode was requested.
int height = 720
 Viewport height in pixels (default: 720).
int index = 0
 Optional acidcam filter mode index.
float mip_bias = 0.0f
 Mipmap level-of-detail bias requested by --mip-bias.
std::string model
 Optional model filename (--model).
bool mxwriteBlockWhenFull = false
 Make MXWrite block instead of dropping frames (--mxwrite-block).
bool nowarpfix = false
 Disable perspective-correct texture mapping (--nowarpfix).
std::string output
 Optional output filename (--output).
std::string path = "."
 Asset root; proc_args() defaults it to the executable directory.
bool repeat = false
 Enable repeat behavior such as playback looping or wrapped textures.
bool resolutionSpecified = false
 Whether -r/–resolution was provided.
std::string resource
 Resource file.
std::string resource_path
 Resource path.
int shader_index = 0
 Optional initial shader entry index.
std::string shaderPath
 Optional SPV shader folder path (-S / --shader-path).
std::string texture
 Optional texture file path (--texture).
int width = 1280
 Viewport width in pixels (default: 1280).
bool wireframe = false
 Render supported 3D models as wireframes (--wireframe).

Detailed Description

Plain data structure returned by proc_args() with all common libmx2 CLI options.

Definition at line 730 of file argz.hpp.

Member Data Documentation

◆ benchmark

bool Arguments::benchmark = false

Enable application benchmark mode (--benchmark).

Definition at line 753 of file argz.hpp.

◆ binary

bool Arguments::binary = false

Use binary glyphs only (--binary).

Definition at line 748 of file argz.hpp.

◆ camera_index

int Arguments::camera_index = 0

Optional camera index.

Definition at line 767 of file argz.hpp.

◆ color

std::string Arguments::color

Optional rain RGB tint (--color).

Definition at line 763 of file argz.hpp.

◆ crf

std::string Arguments::crf

Optional CRF value (--crf).

Definition at line 741 of file argz.hpp.

◆ disable_mipmap

bool Arguments::disable_mipmap = false

Disable mipmap generation and selection (--disable-mipmap).

Definition at line 756 of file argz.hpp.

◆ disable_sound

bool Arguments::disable_sound = false

Disable application background music (--disable-sound).

Definition at line 752 of file argz.hpp.

◆ enable_crt

bool Arguments::enable_crt = false

Enable CRT post-processing at startup (--enable-crt).

Definition at line 749 of file argz.hpp.

◆ enable_screenshot

bool Arguments::enable_screenshot = false

Enable F10 screenshot capture (--enable-screenshot).

Definition at line 751 of file argz.hpp.

◆ enable_vsync

bool Arguments::enable_vsync = false

Enable FIFO present mode / v-sync (--enable-vsync).

Definition at line 750 of file argz.hpp.

◆ encodeCodec

std::string Arguments::encodeCodec

Optional encoder codec policy/name (--encode-codec).

Definition at line 744 of file argz.hpp.

◆ encodePreset

std::string Arguments::encodePreset

Optional encoder preset (--encode-preset).

Definition at line 742 of file argz.hpp.

◆ encodeRealtime

bool Arguments::encodeRealtime = false

Enable low-latency encoder settings (--encode-realtime).

Definition at line 745 of file argz.hpp.

◆ encodeTune

std::string Arguments::encodeTune

Optional encoder tune (--encode-tune).

Definition at line 743 of file argz.hpp.

◆ executable_name

std::string Arguments::executable_name = "mxvk"

Executable basename derived from argv[0].

Definition at line 731 of file argz.hpp.

◆ fast

bool Arguments::fast = false

Whether fast mode was requested (--fast).

Definition at line 737 of file argz.hpp.

◆ filename

std::string Arguments::filename

Optional input filename (--filename).

Definition at line 738 of file argz.hpp.

◆ font_path

std::string Arguments::font_path

Optional font file path (--font-path).

Definition at line 762 of file argz.hpp.

◆ font_size

int Arguments::font_size = 22

Matrix rain font size in pixels (--font-size).

Definition at line 761 of file argz.hpp.

◆ fps

double Arguments::fps = 0.0

Optional FPS override (--fps); non-positive means unspecified.

Definition at line 760 of file argz.hpp.

◆ fragmentPath

std::string Arguments::fragmentPath

Optional fragment shader SPV path (--fragment).

Definition at line 766 of file argz.hpp.

◆ framebuffer

FramebufferDimensions Arguments::framebuffer

Software framebuffer size requested by --framebuffer.

Definition at line 758 of file argz.hpp.

◆ framebufferSpecified

bool Arguments::framebufferSpecified = false

Whether --framebuffer was provided.

Definition at line 759 of file argz.hpp.

◆ fullscreen

bool Arguments::fullscreen = false

Whether fullscreen mode was requested.

Definition at line 736 of file argz.hpp.

◆ height

int Arguments::height = 720

Viewport height in pixels (default: 720).

Definition at line 733 of file argz.hpp.

◆ index

int Arguments::index = 0

Optional acidcam filter mode index.

Definition at line 768 of file argz.hpp.

◆ mip_bias

float Arguments::mip_bias = 0.0f

Mipmap level-of-detail bias requested by --mip-bias.

Definition at line 757 of file argz.hpp.

◆ model

std::string Arguments::model

Optional model filename (--model).

Definition at line 739 of file argz.hpp.

◆ mxwriteBlockWhenFull

bool Arguments::mxwriteBlockWhenFull = false

Make MXWrite block instead of dropping frames (--mxwrite-block).

Definition at line 746 of file argz.hpp.

◆ nowarpfix

bool Arguments::nowarpfix = false

Disable perspective-correct texture mapping (--nowarpfix).

Definition at line 755 of file argz.hpp.

◆ output

std::string Arguments::output

Optional output filename (--output).

Definition at line 740 of file argz.hpp.

◆ path

std::string Arguments::path = "."

Asset root; proc_args() defaults it to the executable directory.

Definition at line 735 of file argz.hpp.

◆ repeat

bool Arguments::repeat = false

Enable repeat behavior such as playback looping or wrapped textures.

Definition at line 747 of file argz.hpp.

◆ resolutionSpecified

bool Arguments::resolutionSpecified = false

Whether -r/–resolution was provided.

Definition at line 734 of file argz.hpp.

◆ resource

std::string Arguments::resource

Resource file.

Definition at line 770 of file argz.hpp.

◆ resource_path

std::string Arguments::resource_path

Resource path.

Definition at line 771 of file argz.hpp.

◆ shader_index

int Arguments::shader_index = 0

Optional initial shader entry index.

Definition at line 769 of file argz.hpp.

◆ shaderPath

std::string Arguments::shaderPath

Optional SPV shader folder path (-S / --shader-path).

Definition at line 765 of file argz.hpp.

◆ texture

std::string Arguments::texture

Optional texture file path (--texture).

Definition at line 764 of file argz.hpp.

◆ width

int Arguments::width = 1280

Viewport width in pixels (default: 1280).

Definition at line 732 of file argz.hpp.

◆ wireframe

bool Arguments::wireframe = false

Render supported 3D models as wireframes (--wireframe).

Definition at line 754 of file argz.hpp.


The documentation for this struct was generated from the following file: