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

fix doc

Browse Source
This commit is contained in:
Lin Wang 2022-08-29 23:30:04 -04:00
parent f5da97d115
commit cddf42ada7
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
imgui/src/stacks.rs
View File

@ -179,7 +179,8 @@ unsafe fn push_style_var(style_var: StyleVar) {
impl Ui {
/// Changes the item width by pushing a change to the item width stack.
///
/// Returns an `ItemWidthStackToken` that may be popped by calling `.pop()`
/// Returns an `ItemWidthStackToken`. The pushed width item is popped when either
/// `ItemWidthStackToken` goes out of scope, or `.end()` is called.
///
/// - `> 0.0`: width is `item_width` pixels
/// - `= 0.0`: default to ~2/3 of window width
@ -208,13 +209,14 @@ impl Ui {
unsafe { sys::igCalcItemWidth() }
}
/// Changes the text wrapping position to the end of window (or column), which
/// is generally the default.
/// Makes the text wrap at the end of window/column (which is generally the default), by
/// pushing a change to the text wrapping position stack.
///
/// This is the same as calling [push_text_wrap_pos_with_pos](Self::push_text_wrap_pos_with_pos)
/// with `wrap_pos_x` set to 0.0.
///
/// Returns a `TextWrapPosStackToken` that may be popped by calling `.pop()`
/// Returns a `TextWrapPosStackToken`. The pushed position item is popped when either
/// `TextWrapPosStackToken` goes out of scope, or `.end()` is called.
#[doc(alias = "PushTextWrapPos")]
pub fn push_text_wrap_pos(&self) -> TextWrapPosStackToken<'_> {
self.push_text_wrap_pos_with_pos(0.0)
@ -222,7 +224,8 @@ impl Ui {
/// Changes the text wrapping position by pushing a change to the text wrapping position stack.
///
/// Returns a `TextWrapPosStackToken` that may be popped by calling `.pop()`
/// Returns a `TextWrapPosStackToken`. The pushed position item is popped when either
/// `TextWrapPosStackToken` goes out of scope, or `.end()` is called.
///
/// - `> 0.0`: wrap at `wrap_pos_x` position in window local space
/// - `= 0.0`: wrap to end of window (or column)