elias/imgui-rs
1
0
Fork 0
mirror of https://github.com/eliasstepanik/imgui-rs.git synced 2026-01-27 13:28:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #251 from Jasper-Bekkers/master

Browse Source 
Mark a bunch of methods that return a builder as `must_use`
This commit is contained in:
Joonas Javanainen 2019-09-04 09:22:18 +03:00 committed by GitHub
commit 390042db10
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/lib.rs
View File

@ -229,9 +229,11 @@ impl<T> From<*mut T> for Id<'static> {
// Widgets: Input // Widgets: Input
impl<'ui> Ui<'ui> { impl<'ui> Ui<'ui> {
#[must_use]
pub fn input_text<'p>(&self, label: &'p ImStr, buf: &'p mut ImString) -> InputText<'ui, 'p> { pub fn input_text<'p>(&self, label: &'p ImStr, buf: &'p mut ImString) -> InputText<'ui, 'p> {
InputText::new(self, label, buf) InputText::new(self, label, buf)
} }
#[must_use]
pub fn input_text_multiline<'p>( pub fn input_text_multiline<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -240,9 +242,11 @@ impl<'ui> Ui<'ui> {
) -> InputTextMultiline<'ui, 'p> { ) -> InputTextMultiline<'ui, 'p> {
InputTextMultiline::new(self, label, buf, size.into()) InputTextMultiline::new(self, label, buf, size.into())
} }
#[must_use]
pub fn input_float<'p>(&self, label: &'p ImStr, value: &'p mut f32) -> InputFloat<'ui, 'p> { pub fn input_float<'p>(&self, label: &'p ImStr, value: &'p mut f32) -> InputFloat<'ui, 'p> {
InputFloat::new(self, label, value) InputFloat::new(self, label, value)
} }
#[must_use]
pub fn input_float2<'p>( pub fn input_float2<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -250,6 +254,7 @@ impl<'ui> Ui<'ui> {
) -> InputFloat2<'ui, 'p> { ) -> InputFloat2<'ui, 'p> {
InputFloat2::new(self, label, value) InputFloat2::new(self, label, value)
} }
#[must_use]
pub fn input_float3<'p>( pub fn input_float3<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -257,6 +262,7 @@ impl<'ui> Ui<'ui> {
) -> InputFloat3<'ui, 'p> { ) -> InputFloat3<'ui, 'p> {
InputFloat3::new(self, label, value) InputFloat3::new(self, label, value)
} }
#[must_use]
pub fn input_float4<'p>( pub fn input_float4<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -264,15 +270,19 @@ impl<'ui> Ui<'ui> {
) -> InputFloat4<'ui, 'p> { ) -> InputFloat4<'ui, 'p> {
InputFloat4::new(self, label, value) InputFloat4::new(self, label, value)
} }
#[must_use]
pub fn input_int<'p>(&self, label: &'p ImStr, value: &'p mut i32) -> InputInt<'ui, 'p> { pub fn input_int<'p>(&self, label: &'p ImStr, value: &'p mut i32) -> InputInt<'ui, 'p> {
InputInt::new(self, label, value) InputInt::new(self, label, value)
} }
#[must_use]
pub fn input_int2<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 2]) -> InputInt2<'ui, 'p> { pub fn input_int2<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 2]) -> InputInt2<'ui, 'p> {
InputInt2::new(self, label, value) InputInt2::new(self, label, value)
} }
#[must_use]
pub fn input_int3<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 3]) -> InputInt3<'ui, 'p> { pub fn input_int3<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 3]) -> InputInt3<'ui, 'p> {
InputInt3::new(self, label, value) InputInt3::new(self, label, value)
} }
#[must_use]
pub fn input_int4<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 4]) -> InputInt4<'ui, 'p> { pub fn input_int4<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 4]) -> InputInt4<'ui, 'p> {
InputInt4::new(self, label, value) InputInt4::new(self, label, value)
} }
@ -280,9 +290,11 @@ impl<'ui> Ui<'ui> {
// Widgets: Drag // Widgets: Drag
impl<'ui> Ui<'ui> { impl<'ui> Ui<'ui> {
#[must_use]
pub fn drag_float<'p>(&self, label: &'p ImStr, value: &'p mut f32) -> DragFloat<'ui, 'p> { pub fn drag_float<'p>(&self, label: &'p ImStr, value: &'p mut f32) -> DragFloat<'ui, 'p> {
DragFloat::new(self, label, value) DragFloat::new(self, label, value)
} }
#[must_use]
pub fn drag_float2<'p>( pub fn drag_float2<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -290,6 +302,7 @@ impl<'ui> Ui<'ui> {
) -> DragFloat2<'ui, 'p> { ) -> DragFloat2<'ui, 'p> {
DragFloat2::new(self, label, value) DragFloat2::new(self, label, value)
} }
#[must_use]
pub fn drag_float3<'p>( pub fn drag_float3<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -297,6 +310,7 @@ impl<'ui> Ui<'ui> {
) -> DragFloat3<'ui, 'p> { ) -> DragFloat3<'ui, 'p> {
DragFloat3::new(self, label, value) DragFloat3::new(self, label, value)
} }
#[must_use]
pub fn drag_float4<'p>( pub fn drag_float4<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -304,6 +318,7 @@ impl<'ui> Ui<'ui> {
) -> DragFloat4<'ui, 'p> { ) -> DragFloat4<'ui, 'p> {
DragFloat4::new(self, label, value) DragFloat4::new(self, label, value)
} }
#[must_use]
pub fn drag_float_range2<'p>( pub fn drag_float_range2<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -312,18 +327,23 @@ impl<'ui> Ui<'ui> {
) -> DragFloatRange2<'ui, 'p> { ) -> DragFloatRange2<'ui, 'p> {
DragFloatRange2::new(self, label, current_min, current_max) DragFloatRange2::new(self, label, current_min, current_max)
} }
#[must_use]
pub fn drag_int<'p>(&self, label: &'p ImStr, value: &'p mut i32) -> DragInt<'ui, 'p> { pub fn drag_int<'p>(&self, label: &'p ImStr, value: &'p mut i32) -> DragInt<'ui, 'p> {
DragInt::new(self, label, value) DragInt::new(self, label, value)
} }
#[must_use]
pub fn drag_int2<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 2]) -> DragInt2<'ui, 'p> { pub fn drag_int2<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 2]) -> DragInt2<'ui, 'p> {
DragInt2::new(self, label, value) DragInt2::new(self, label, value)
} }
#[must_use]
pub fn drag_int3<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 3]) -> DragInt3<'ui, 'p> { pub fn drag_int3<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 3]) -> DragInt3<'ui, 'p> {
DragInt3::new(self, label, value) DragInt3::new(self, label, value)
} }
#[must_use]
pub fn drag_int4<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 4]) -> DragInt4<'ui, 'p> { pub fn drag_int4<'p>(&self, label: &'p ImStr, value: &'p mut [i32; 4]) -> DragInt4<'ui, 'p> {
DragInt4::new(self, label, value) DragInt4::new(self, label, value)
} }
#[must_use]
pub fn drag_int_range2<'p>( pub fn drag_int_range2<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -425,6 +445,7 @@ impl<'ui> Ui<'ui> {
/// } /// }
/// }); /// });
/// ``` /// ```
#[must_use]
pub fn popup_modal<'p>(&self, str_id: &'p ImStr) -> PopupModal<'ui, 'p> { pub fn popup_modal<'p>(&self, str_id: &'p ImStr) -> PopupModal<'ui, 'p> {
PopupModal::new(self, str_id) PopupModal::new(self, str_id)
} }
@ -461,12 +482,14 @@ impl<'ui> Ui<'ui> {
} }
impl<'ui> Ui<'ui> { impl<'ui> Ui<'ui> {
#[must_use]
pub fn plot_lines<'p>(&self, label: &'p ImStr, values: &'p [f32]) -> PlotLines<'ui, 'p> { pub fn plot_lines<'p>(&self, label: &'p ImStr, values: &'p [f32]) -> PlotLines<'ui, 'p> {
PlotLines::new(self, label, values) PlotLines::new(self, label, values)
} }
} }
impl<'ui> Ui<'ui> { impl<'ui> Ui<'ui> {
#[must_use]
pub fn plot_histogram<'p>( pub fn plot_histogram<'p>(
&self, &self,
label: &'p ImStr, label: &'p ImStr,
@ -532,6 +555,7 @@ impl<'ui> Ui<'ui> {
/// let draw_list = ui.get_window_draw_list(); /// let draw_list = ui.get_window_draw_list();
/// } /// }
/// ``` /// ```
#[must_use]
pub fn get_window_draw_list(&'ui self) -> WindowDrawList<'ui> { pub fn get_window_draw_list(&'ui self) -> WindowDrawList<'ui> {
WindowDrawList::new(self) WindowDrawList::new(self)
} }