pub struct Graphics {
pub video_file: Option<PathBuf>,
pub bmp_files: HashMap<ObjId, Bmp>,
pub bga_changes: BTreeMap<ObjTime, BgaObj>,
pub poor_bmp: Option<PathBuf>,
pub poor_bga_mode: PoorMode,
pub materials_bmp: Vec<PathBuf>,
pub char_file: Option<PathBuf>,
pub video_colors: Option<u8>,
pub video_dly: Option<Decimal>,
pub video_fs: Option<Decimal>,
pub bga_opacity_changes: HashMap<BgaLayer, BTreeMap<ObjTime, BgaOpacityObj>>,
pub bga_argb_changes: HashMap<BgaLayer, BTreeMap<ObjTime, BgaArgbObj>>,
}
Expand description
The graphics objects that are used in the score.
Fields§
§video_file: Option<PathBuf>
The path of the background video. The video should be started the playing from the section 000. This video is displayed behind the gameplay area. Its audio track should not be played.
bmp_files: HashMap<ObjId, Bmp>
The BMP file paths corresponding to the id of the background image/video object.
bga_changes: BTreeMap<ObjTime, BgaObj>
BGA change events, indexed by time. #BGA, #BGAPOOR, #BGALAYER
poor_bmp: Option<PathBuf>
The path of image, which is shown when the player got POOR. This image is displayed when the player misses a note or gets a poor judgment.
poor_bga_mode: PoorMode
The display mode for background image/video.
materials_bmp: Vec<PathBuf>
Material BMP file paths. #MATERIALSBMP
char_file: Option<PathBuf>
Character file path. #CHARFILE
video_colors: Option<u8>
Video color depth. #VIDEOCOLORS
video_dly: Option<Decimal>
Video delay. #VIDEODLY
video_fs: Option<Decimal>
Video frame rate. #VIDEOF/S
bga_opacity_changes: HashMap<BgaLayer, BTreeMap<ObjTime, BgaOpacityObj>>
BGA opacity change events, indexed by time. #0B, #0C, #0D, #0E
bga_argb_changes: HashMap<BgaLayer, BTreeMap<ObjTime, BgaArgbObj>>
BGA ARGB color change events, indexed by time. #A1, #A2, #A3, #A4
Implementations§
Source§impl Graphics
impl Graphics
Sourcepub const fn bga_changes(&self) -> &BTreeMap<ObjTime, BgaObj>
pub const fn bga_changes(&self) -> &BTreeMap<ObjTime, BgaObj>
Returns the bga change objects.
Sourcepub fn push_bga_change(
&mut self,
bga: BgaObj,
channel: Channel,
prompt_handler: &mut impl PromptHandler,
) -> Result<(), ParseWarning>
pub fn push_bga_change( &mut self, bga: BgaObj, channel: Channel, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>
Adds a new bga change object to the notes.
Sourcepub fn push_bga_opacity_change(
&mut self,
opacity_obj: BgaOpacityObj,
channel: Channel,
prompt_handler: &mut impl PromptHandler,
) -> Result<(), ParseWarning>
pub fn push_bga_opacity_change( &mut self, opacity_obj: BgaOpacityObj, channel: Channel, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>
Adds a new BGA opacity change object to the graphics.
Sourcepub fn push_bga_argb_change(
&mut self,
argb_obj: BgaArgbObj,
channel: Channel,
prompt_handler: &mut impl PromptHandler,
) -> Result<(), ParseWarning>
pub fn push_bga_argb_change( &mut self, argb_obj: BgaArgbObj, channel: Channel, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>
Adds a new BGA ARGB color change object to the graphics.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Graphics
impl<'de> Deserialize<'de> for Graphics
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
impl Eq for Graphics
impl StructuralPartialEq for Graphics
Auto Trait Implementations§
impl Freeze for Graphics
impl RefUnwindSafe for Graphics
impl Send for Graphics
impl Sync for Graphics
impl Unpin for Graphics
impl UnwindSafe for Graphics
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§impl<T> SourceRangeMixinExt for T
impl<T> SourceRangeMixinExt for T
Source§fn into_wrapper<W>(
self,
wrapper: &SourceRangeMixin<W>,
) -> SourceRangeMixin<Self>where
Self: Sized,
fn into_wrapper<W>(
self,
wrapper: &SourceRangeMixin<W>,
) -> SourceRangeMixin<Self>where
Self: Sized,
SourceRangeMixin
with the same span as a wrapper.Source§fn into_wrapper_range(self, range: Range<usize>) -> SourceRangeMixin<Self>where
Self: Sized,
fn into_wrapper_range(self, range: Range<usize>) -> SourceRangeMixin<Self>where
Self: Sized,
SourceRangeMixin
with a given range.Source§fn into_wrapper_span(self, span: (usize, usize)) -> SourceRangeMixin<Self>where
Self: Sized,
fn into_wrapper_span(self, span: (usize, usize)) -> SourceRangeMixin<Self>where
Self: Sized,
SourceRangeMixin
with a given (start, end) span.