[−][src]Struct amethyst_ui::UiButtonData

pub struct UiButtonData<W: WidgetId = u32> {
    pub id: Option<W>,
    pub text: String,
    pub font_size: f32,
    pub font: Option<AssetPrefab<FontAsset>>,
    pub normal_text_color: [f32; 4],
    pub normal_image: Option<UiImageLoadPrefab>,
    pub hover_image: Option<UiImageLoadPrefab>,
    pub hover_text_color: Option<[f32; 4]>,
    pub press_image: Option<UiImageLoadPrefab>,
    pub press_text_color: Option<[f32; 4]>,
    pub hover_sound: Option<AssetPrefab<Audio>>,
    pub press_sound: Option<AssetPrefab<Audio>>,
    pub release_sound: Option<AssetPrefab<Audio>>,
}

Loadable UiButton data

Type parameters:

W: Type used for Widget IDs

Fields

id: Option<W>

Id for the widget

text: String

Text to display

font_size: f32

Font size

font: Option<AssetPrefab<FontAsset>>

Font

normal_text_color: [f32; 4]

Default text color

normal_image: Option<UiImageLoadPrefab>

Default image

hover_image: Option<UiImageLoadPrefab>

Image used when the mouse hovers over this element

hover_text_color: Option<[f32; 4]>

Text color used when this button is hovered over

press_image: Option<UiImageLoadPrefab>

Image used when button is pressed

press_text_color: Option<[f32; 4]>

Text color used when this button is pressed

hover_sound: Option<AssetPrefab<Audio>>

Sound made when this button is hovered over

press_sound: Option<AssetPrefab<Audio>>

Sound made when this button is pressed.

release_sound: Option<AssetPrefab<Audio>>

Sound made when this button is released.

Trait Implementations

`impl<W: Clone + WidgetId> Clone for UiButtonData<W>`[src]

`fn clone(&self) -> UiButtonData<W>`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from source. Read more

`impl<W: WidgetId + Debug> Debug for UiButtonData<W>`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<W: WidgetId> Serialize for UiButtonData<W> where W: Serialize,` [src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl<'de, W: WidgetId> Deserialize<'de> for UiButtonData<W> where W: Deserialize<'de>,` [src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

`impl<'a, W> PrefabData<'a> for UiButtonData<W> where W: WidgetId,` [src]

`type SystemData = (WriteStorage<'a, UiSoundRetrigger>, WriteStorage<'a, UiButtonActionRetrigger>, Write<'a, Widgets<UiButton, W>>, <UiImageLoadPrefab as PrefabData<'a>>::SystemData, <AssetPrefab<Audio> as PrefabData<'a>>::SystemData)`

SystemData needed to perform the load

`type Result = ()`

The result type returned by the load operation

`fn add_to_entity( &self, entity: Entity, system_data: &mut Self::SystemData, entity_set: &[Entity], children: &[Entity] ) -> Result<(), Error>`[src]

`fn load_sub_assets( &mut self, progress: &mut ProgressCounter, system_data: &mut Self::SystemData ) -> Result<bool, Error>`[src]

Auto Trait Implementations

`impl<W> Unpin for UiButtonData<W> where W: Unpin,`

`impl<W> Sync for UiButtonData<W>`

`impl<W> Send for UiButtonData<W>`

`impl<W = u32> !UnwindSafe for UiButtonData<W>`

`impl<W = u32> !RefUnwindSafe for UiButtonData<W>`

Blanket Implementations

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

Should always be Self

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`fn to_subset(&self) -> Option<SS>`[src]

`fn is_in_subset(&self) -> bool`[src]

`unsafe fn to_subset_unchecked(&self) -> SS`[src]

`fn from_subset(element: &SS) -> SP`[src]

`impl<T> DeserializeOwned for T where T: Deserialize<'de>,` [src]

`impl<T> Resource for T where T: Any + Send + Sync,` [src]

`impl<T> Any for T where T: Any,` [src]

`fn get_type_id(&self) -> TypeId`[src]

`impl<T> Event for T where T: Send + Sync + 'static,` [src]

`impl<T> Serialize for T where T: Serialize + ?Sized,` [src]

`fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>`[src]

`impl<T> Erased for T`[src]

`impl<T> Clone for T where T: Clone,` [src]

`unsafe fn clone_box(&self) -> *mut ()`[src]

`impl<T> SetParameter for T`[src]

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,` [src]

Sets value as a parameter of self.

`impl<T> Supports<T> for T`[src]

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

Convert the source color to the destination color using the bradford method by default Read more

[−][src]Struct amethyst_ui::UiButtonData

Type parameters:

Fields

Trait Implementations

impl<W: Clone + WidgetId> Clone for UiButtonData<W>[src]

fn clone(&self) -> UiButtonData<W>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl<W: WidgetId + Debug> Debug for UiButtonData<W>[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl<W: WidgetId> Serialize for UiButtonData<W> where W: Serialize, [src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer, [src]

impl<'de, W: WidgetId> Deserialize<'de> for UiButtonData<W> where W: Deserialize<'de>, [src]

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>, [src]

impl<'a, W> PrefabData<'a> for UiButtonData<W> where W: WidgetId, [src]

type SystemData = (WriteStorage<'a, UiSoundRetrigger>, WriteStorage<'a, UiButtonActionRetrigger>, Write<'a, Widgets<UiButton, W>>, <UiImageLoadPrefab as PrefabData<'a>>::SystemData, <AssetPrefab<Audio> as PrefabData<'a>>::SystemData)

type Result = ()

fn add_to_entity( &self, entity: Entity, system_data: &mut Self::SystemData, entity_set: &[Entity], children: &[Entity]) -> Result<(), Error>[src]

fn load_sub_assets( &mut self, progress: &mut ProgressCounter, system_data: &mut Self::SystemData) -> Result<bool, Error>[src]

Auto Trait Implementations

impl<W> Unpin for UiButtonData<W> where W: Unpin,

impl<W> Sync for UiButtonData<W>

impl<W> Send for UiButtonData<W>

impl<W = u32> !UnwindSafe for UiButtonData<W>

impl<W = u32> !RefUnwindSafe for UiButtonData<W>

Blanket Implementations

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

impl<T> Same<T> for T[src]

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

fn to_subset(&self) -> Option<SS>[src]

fn is_in_subset(&self) -> bool[src]

unsafe fn to_subset_unchecked(&self) -> SS[src]

fn from_subset(element: &SS) -> SP[src]

impl<T> DeserializeOwned for T where T: Deserialize<'de>, [src]

impl<T> Resource for T where T: Any + Send + Sync, [src]

impl<T> Any for T where T: Any, [src]

fn get_type_id(&self) -> TypeId[src]

impl<T> Event for T where T: Send + Sync + 'static, [src]

impl<T> Serialize for T where T: Serialize + ?Sized, [src]

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>[src]

impl<T> Erased for T[src]

impl<T> Clone for T where T: Clone, [src]

unsafe fn clone_box(&self) -> *mut ()[src]

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>, [src]

impl<T> Supports<T> for T[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float, [src]

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>, [src]

fn adapt_into(self) -> D[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>, [src]

fn vzip(self) -> V[src]