1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
//! The draw list lets you create custom graphics within a window.
//!
//! Each dear imgui window contains its own draw list. You can use
//! [`Ui::get_window_draw_list`] to access the current window draw
//! list and draw custom primitives. You can interleave normal widget
//! calls and adding primitives to the current draw list.
//!
//! Interaction is mostly through the mtehods [`DrawListMut`] struct,
//! such as [`DrawListMut::add_line`], however you can also construct
//! structs like [`Line`] directly, then call
//! `Line::build` with a reference to your draw list
//!
//! There are examples such as `draw_list.rs` and `custom_textures.rs`
//! within the `imgui-examples` directory
use bitflags::bitflags;
use crate::ImColor32;
use sys::ImDrawList;
use super::Ui;
use crate::render::renderer::TextureId;
use std::marker::PhantomData;
bitflags!(
/// Draw list flags
#[repr(C)]
pub struct DrawListFlags: u32 {
const NONE = sys::ImDrawListFlags_None;
/// Enable anti-aliased lines/borders (*2 the number of triangles for 1.0f wide line or lines
/// thin enough to be drawn using textures, otherwise *3 the number of triangles)
const ANTI_ALIASED_LINES = sys::ImDrawListFlags_AntiAliasedLines;
/// Enable anti-aliased lines/borders using textures when possible. Require backend to render
/// with bilinear filtering.
const ANTI_ALIASED_LINES_USE_TEX = sys::ImDrawListFlags_AntiAliasedLinesUseTex;
/// Enable anti-aliased edge around filled shapes (rounded rectangles, circles).
const ANTI_ALIASED_FILL = sys::ImDrawListFlags_AntiAliasedFill;
/// Can emit 'VtxOffset > 0' to allow large meshes. Set when
/// [`BackendFlags::RENDERER_HAS_VTX_OFFSET`] is enabled.
const ALLOW_VTX_OFFSET = sys::ImDrawListFlags_AllowVtxOffset;
}
);
enum DrawListType {
Window,
Background,
Foreground,
}
/// Object implementing the custom draw API.
///
/// Called from [`Ui::get_window_draw_list`], [`Ui::get_background_draw_list`] or [`Ui::get_foreground_draw_list`].
/// No more than one instance of this structure can live in a program at the same time.
/// The program will panic on creating a second instance.
pub struct DrawListMut<'ui> {
draw_list_type: DrawListType,
draw_list: *mut ImDrawList,
_phantom: PhantomData<&'ui Ui<'ui>>,
}
// Lock for each variant of draw list. See https://github.com/imgui-rs/imgui-rs/issues/488
static DRAW_LIST_LOADED_WINDOW: std::sync::atomic::AtomicBool =
std::sync::atomic::AtomicBool::new(false);
static DRAW_LIST_LOADED_BACKGROUND: std::sync::atomic::AtomicBool =
std::sync::atomic::AtomicBool::new(false);
static DRAW_LIST_LOADED_FOREGROUND: std::sync::atomic::AtomicBool =
std::sync::atomic::AtomicBool::new(false);
impl<'ui> Drop for DrawListMut<'ui> {
fn drop(&mut self) {
match self.draw_list_type {
DrawListType::Window => &DRAW_LIST_LOADED_WINDOW,
DrawListType::Background => &DRAW_LIST_LOADED_BACKGROUND,
DrawListType::Foreground => &DRAW_LIST_LOADED_FOREGROUND,
}
.store(false, std::sync::atomic::Ordering::Release);
}
}
impl<'ui> DrawListMut<'ui> {
fn lock_draw_list(t: DrawListType) {
let lock = match t {
DrawListType::Window => &DRAW_LIST_LOADED_WINDOW,
DrawListType::Background => &DRAW_LIST_LOADED_BACKGROUND,
DrawListType::Foreground => &DRAW_LIST_LOADED_FOREGROUND,
};
let already_loaded = lock
.compare_exchange(
false,
true,
std::sync::atomic::Ordering::Acquire,
std::sync::atomic::Ordering::Relaxed,
)
.is_err();
if already_loaded {
let name = match t {
DrawListType::Window => "window",
DrawListType::Background => "background",
DrawListType::Foreground => "foreground",
};
panic!("The DrawListMut instance for the {} draw list is already loaded! You can only load one instance of it!", name)
}
}
#[doc(alias = "GetWindowDrawList")]
pub(crate) fn window(_: &Ui<'ui>) -> Self {
Self::lock_draw_list(DrawListType::Window);
Self {
draw_list: unsafe { sys::igGetWindowDrawList() },
draw_list_type: DrawListType::Window,
_phantom: PhantomData,
}
}
#[doc(alias = "GetBackgroundDrawList")]
pub(crate) fn background(_: &Ui<'ui>) -> Self {
Self::lock_draw_list(DrawListType::Background);
Self {
draw_list: unsafe { sys::igGetBackgroundDrawList() },
draw_list_type: DrawListType::Background,
_phantom: PhantomData,
}
}
#[doc(alias = "GetForegroundDrawList")]
pub(crate) fn foreground(_: &Ui<'ui>) -> Self {
Self::lock_draw_list(DrawListType::Foreground);
Self {
draw_list: unsafe { sys::igGetForegroundDrawList() },
draw_list_type: DrawListType::Foreground,
_phantom: PhantomData,
}
}
/// Split into *channels_count* drawing channels.
/// At the end of the closure, the channels are merged. The objects
/// are then drawn in the increasing order of their channel number, and not
/// in the order they were called.
///
/// # Example
///
/// ```rust,no_run
/// # use arcdps_imgui::*;
/// fn custom_drawing(ui: &Ui) {
/// let draw_list = ui.get_window_draw_list();
/// draw_list.channels_split(2, |channels| {
/// channels.set_current(1);
/// // ... Draw channel 1
/// channels.set_current(0);
/// // ... Draw channel 0
/// });
/// }
/// ```
#[doc(alias = "ChannelsSplit")]
pub fn channels_split<F: FnOnce(&ChannelsSplit<'_>)>(&self, channels_count: u32, f: F) {
unsafe { sys::ImDrawList_ChannelsSplit(self.draw_list, channels_count as i32) };
f(&ChannelsSplit {
draw_list: self,
channels_count,
});
unsafe { sys::ImDrawList_ChannelsMerge(self.draw_list) };
}
}
/// Represent the drawing interface within a call to [`channels_split`].
///
/// [`channels_split`]: DrawListMut::channels_split
pub struct ChannelsSplit<'ui> {
draw_list: &'ui DrawListMut<'ui>,
channels_count: u32,
}
impl<'ui> ChannelsSplit<'ui> {
/// Change current channel.
///
/// Panic if channel_index overflows the number of channels.
#[doc(alias = "ChannelsSetCurrent")]
pub fn set_current(&self, channel_index: u32) {
assert!(
channel_index < self.channels_count,
"Channel cannot be set! Provided channel index ({}) is higher than channel count ({}).",
channel_index,
self.channels_count
);
unsafe {
sys::ImDrawList_ChannelsSetCurrent(self.draw_list.draw_list, channel_index as i32)
};
}
}
/// Drawing functions
impl<'ui> DrawListMut<'ui> {
/// Returns a line from point `p1` to `p2` with color `c`.
#[doc(alias = "AddLine")]
pub fn add_line<C>(&'ui self, p1: [f32; 2], p2: [f32; 2], c: C) -> Line<'ui>
where
C: Into<ImColor32>,
{
Line::new(self, p1, p2, c)
}
/// Returns a rectangle whose upper-left corner is at point `p1`
/// and lower-right corner is at point `p2`, with color `c`.
#[doc(alias = "AddRectFilled", alias = "AddRect")]
pub fn add_rect<C>(&'ui self, p1: [f32; 2], p2: [f32; 2], c: C) -> Rect<'ui>
where
C: Into<ImColor32>,
{
Rect::new(self, p1, p2, c)
}
/// Draw a rectangle whose upper-left corner is at point `p1`
/// and lower-right corner is at point `p2`.
/// The remains parameters are the respective color of the corners
/// in the counter-clockwise starting from the upper-left corner
/// first.
#[doc(alias = "AddRectFilledMultiColor")]
pub fn add_rect_filled_multicolor<C1, C2, C3, C4>(
&self,
p1: [f32; 2],
p2: [f32; 2],
col_upr_left: C1,
col_upr_right: C2,
col_bot_right: C3,
col_bot_left: C4,
) where
C1: Into<ImColor32>,
C2: Into<ImColor32>,
C3: Into<ImColor32>,
C4: Into<ImColor32>,
{
unsafe {
sys::ImDrawList_AddRectFilledMultiColor(
self.draw_list,
p1.into(),
p2.into(),
col_upr_left.into().into(),
col_upr_right.into().into(),
col_bot_right.into().into(),
col_bot_left.into().into(),
);
}
}
/// Returns a triangle with the given 3 vertices `p1`, `p2` and `p3`
/// and color `c`.
#[doc(alias = "AddTriangleFilled", alias = "AddTriangle")]
pub fn add_triangle<C>(
&'ui self,
p1: [f32; 2],
p2: [f32; 2],
p3: [f32; 2],
c: C,
) -> Triangle<'ui>
where
C: Into<ImColor32>,
{
Triangle::new(self, p1, p2, p3, c)
}
/// Returns a circle with the given `center`, `radius` and `color`.
#[doc(alias = "AddCircleFilled", alias = "AddCircle")]
pub fn add_circle<C>(&'ui self, center: [f32; 2], radius: f32, color: C) -> Circle<'ui>
where
C: Into<ImColor32>,
{
Circle::new(self, center, radius, color)
}
/// Draw a text whose upper-left corner is at point `pos`.
#[doc(alias = "AddText")]
pub fn add_text<C, T>(&self, pos: [f32; 2], col: C, text: T)
where
C: Into<ImColor32>,
T: AsRef<str>,
{
use std::os::raw::c_char;
let text = text.as_ref();
unsafe {
let start = text.as_ptr() as *const c_char;
let end = (start as usize + text.len()) as *const c_char;
sys::ImDrawList_AddText_Vec2(self.draw_list, pos.into(), col.into().into(), start, end)
}
}
/// Returns a Bezier curve stretching from `pos0` to `pos1`, whose
/// curvature is defined by `cp0` and `cp1`.
#[doc(alias = "AddBezier", alias = "AddBezierCubic")]
pub fn add_bezier_curve<C>(
&'ui self,
pos0: [f32; 2],
cp0: [f32; 2],
cp1: [f32; 2],
pos1: [f32; 2],
color: C,
) -> BezierCurve<'ui>
where
C: Into<ImColor32>,
{
BezierCurve::new(self, pos0, cp0, cp1, pos1, color)
}
/// Push a clipping rectangle on the stack, run `f` and pop it.
///
/// Clip all drawings done within the closure `f` in the given
/// rectangle.
#[doc(alias = "PushClipRect", alias = "PopClipRect")]
pub fn with_clip_rect<F>(&self, min: [f32; 2], max: [f32; 2], f: F)
where
F: FnOnce(),
{
unsafe { sys::ImDrawList_PushClipRect(self.draw_list, min.into(), max.into(), false) }
f();
unsafe { sys::ImDrawList_PopClipRect(self.draw_list) }
}
/// Push a clipping rectangle on the stack, run `f` and pop it.
///
/// Clip all drawings done within the closure `f` in the given
/// rectangle. Intersect with all clipping rectangle previously on
/// the stack.
#[doc(alias = "PushClipRect", alias = "PopClipRect")]
pub fn with_clip_rect_intersect<F>(&self, min: [f32; 2], max: [f32; 2], f: F)
where
F: FnOnce(),
{
unsafe { sys::ImDrawList_PushClipRect(self.draw_list, min.into(), max.into(), true) }
f();
unsafe { sys::ImDrawList_PopClipRect(self.draw_list) }
}
}
/// # Images
impl<'ui> DrawListMut<'ui> {
/// Draw the specified image in the rect specified by `p_min` to
/// `p_max`.
///
/// # Examples
///
/// ```
/// # use arcdps_imgui::*;
/// fn custom_button(ui: &Ui, img_id: TextureId) {
/// // Invisible button is good widget to customise with image
/// ui.invisible_button(im_str!("custom_button"), [100.0, 20.0]);
///
/// // Get draw list and draw image over invisible button
/// let draw_list = ui.get_window_draw_list();
/// draw_list
/// .add_image(img_id, ui.item_rect_min(), ui.item_rect_max())
/// .build();
/// }
/// ```
pub fn add_image(
&'ui self,
texture_id: TextureId,
p_min: [f32; 2],
p_max: [f32; 2],
) -> Image<'_> {
Image::new(self, texture_id, p_min, p_max)
}
/// Draw the specified image to a quad with the specified
/// coordinates. Similar to [`DrawListMut::add_image`] but this
/// method is able to draw non-rectangle images.
pub fn add_image_quad(
&'ui self,
texture_id: TextureId,
p1: [f32; 2],
p2: [f32; 2],
p3: [f32; 2],
p4: [f32; 2],
) -> ImageQuad<'_> {
ImageQuad::new(self, texture_id, p1, p2, p3, p4)
}
/// Draw the speciied image, with rounded corners
pub fn add_image_rounded(
&'ui self,
texture_id: TextureId,
p_min: [f32; 2],
p_max: [f32; 2],
rounding: f32,
) -> ImageRounded<'_> {
ImageRounded::new(self, texture_id, p_min, p_max, rounding)
}
}
/// Represents a line about to be drawn
#[must_use = "should call .build() to draw the object"]
pub struct Line<'ui> {
p1: [f32; 2],
p2: [f32; 2],
color: ImColor32,
thickness: f32,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> Line<'ui> {
fn new<C>(draw_list: &'ui DrawListMut<'_>, p1: [f32; 2], p2: [f32; 2], c: C) -> Self
where
C: Into<ImColor32>,
{
Self {
p1,
p2,
color: c.into(),
thickness: 1.0,
draw_list,
}
}
/// Set line's thickness (default to 1.0 pixel)
pub fn thickness(mut self, thickness: f32) -> Self {
self.thickness = thickness;
self
}
/// Draw the line on the window
pub fn build(self) {
unsafe {
sys::ImDrawList_AddLine(
self.draw_list.draw_list,
self.p1.into(),
self.p2.into(),
self.color.into(),
self.thickness,
)
}
}
}
bitflags!(
/// Flags for indicating which corner of a rectangle should be rounded
#[repr(C)]
pub struct ImDrawCornerFlags: u32 {
const TOP_LEFT = 1;
const TOP_RIGHT = 1 << 1;
const BOT_LEFT = 1 << 2;
const BOT_RIGHT = 1 << 3;
const TOP = ImDrawCornerFlags::TOP_LEFT.bits
| ImDrawCornerFlags::TOP_RIGHT.bits;
const BOT = ImDrawCornerFlags::BOT_LEFT.bits
| ImDrawCornerFlags::BOT_RIGHT.bits;
const LEFT = ImDrawCornerFlags::TOP_LEFT.bits
| ImDrawCornerFlags::BOT_LEFT.bits;
const RIGHT = ImDrawCornerFlags::TOP_RIGHT.bits
| ImDrawCornerFlags::BOT_RIGHT.bits;
const ALL = 0xF;
}
);
/// Represents a rectangle about to be drawn
#[must_use = "should call .build() to draw the object"]
pub struct Rect<'ui> {
p1: [f32; 2],
p2: [f32; 2],
color: ImColor32,
rounding: f32,
flags: ImDrawCornerFlags,
thickness: f32,
filled: bool,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> Rect<'ui> {
fn new<C>(draw_list: &'ui DrawListMut<'_>, p1: [f32; 2], p2: [f32; 2], c: C) -> Self
where
C: Into<ImColor32>,
{
Self {
p1,
p2,
color: c.into(),
rounding: 0.0,
flags: ImDrawCornerFlags::ALL,
thickness: 1.0,
filled: false,
draw_list,
}
}
/// Set rectangle's corner rounding (default to 0.0: no rounding).
/// By default all corners are rounded if this value is set.
pub fn rounding(mut self, rounding: f32) -> Self {
self.rounding = rounding;
self
}
/// Set flag to indicate if rectangle's top-left corner will be rounded.
pub fn round_top_left(mut self, value: bool) -> Self {
self.flags.set(ImDrawCornerFlags::TOP_LEFT, value);
self
}
/// Set flag to indicate if rectangle's top-right corner will be rounded.
pub fn round_top_right(mut self, value: bool) -> Self {
self.flags.set(ImDrawCornerFlags::TOP_RIGHT, value);
self
}
/// Set flag to indicate if rectangle's bottom-left corner will be rounded.
pub fn round_bot_left(mut self, value: bool) -> Self {
self.flags.set(ImDrawCornerFlags::BOT_LEFT, value);
self
}
/// Set flag to indicate if rectangle's bottom-right corner will be rounded.
pub fn round_bot_right(mut self, value: bool) -> Self {
self.flags.set(ImDrawCornerFlags::BOT_RIGHT, value);
self
}
/// Set rectangle's thickness (default to 1.0 pixel).
pub fn thickness(mut self, thickness: f32) -> Self {
self.thickness = thickness;
self
}
/// Set to `true` to make a filled rectangle (default to `false`).
pub fn filled(mut self, filled: bool) -> Self {
self.filled = filled;
self
}
/// Draw the rectangle on the window.
pub fn build(self) {
if self.filled {
unsafe {
sys::ImDrawList_AddRectFilled(
self.draw_list.draw_list,
self.p1.into(),
self.p2.into(),
self.color.into(),
self.rounding,
self.flags.bits() as i32,
);
}
} else {
unsafe {
sys::ImDrawList_AddRect(
self.draw_list.draw_list,
self.p1.into(),
self.p2.into(),
self.color.into(),
self.rounding,
self.flags.bits() as i32,
self.thickness,
);
}
}
}
}
/// Represents a triangle about to be drawn on the window
#[must_use = "should call .build() to draw the object"]
pub struct Triangle<'ui> {
p1: [f32; 2],
p2: [f32; 2],
p3: [f32; 2],
color: ImColor32,
thickness: f32,
filled: bool,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> Triangle<'ui> {
fn new<C>(
draw_list: &'ui DrawListMut<'_>,
p1: [f32; 2],
p2: [f32; 2],
p3: [f32; 2],
c: C,
) -> Self
where
C: Into<ImColor32>,
{
Self {
p1,
p2,
p3,
color: c.into(),
thickness: 1.0,
filled: false,
draw_list,
}
}
/// Set triangle's thickness (default to 1.0 pixel)
pub fn thickness(mut self, thickness: f32) -> Self {
self.thickness = thickness;
self
}
/// Set to `true` to make a filled triangle (default to `false`).
pub fn filled(mut self, filled: bool) -> Self {
self.filled = filled;
self
}
/// Draw the triangle on the window.
pub fn build(self) {
if self.filled {
unsafe {
sys::ImDrawList_AddTriangleFilled(
self.draw_list.draw_list,
self.p1.into(),
self.p2.into(),
self.p3.into(),
self.color.into(),
)
}
} else {
unsafe {
sys::ImDrawList_AddTriangle(
self.draw_list.draw_list,
self.p1.into(),
self.p2.into(),
self.p3.into(),
self.color.into(),
self.thickness,
)
}
}
}
}
/// Represents a circle about to be drawn
#[must_use = "should call .build() to draw the object"]
pub struct Circle<'ui> {
center: [f32; 2],
radius: f32,
color: ImColor32,
num_segments: u32,
thickness: f32,
filled: bool,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> Circle<'ui> {
/// Typically constructed by [`DrawListMut::add_circle`]
pub fn new<C>(draw_list: &'ui DrawListMut<'_>, center: [f32; 2], radius: f32, color: C) -> Self
where
C: Into<ImColor32>,
{
Self {
center,
radius,
color: color.into(),
num_segments: 0,
thickness: 1.0,
filled: false,
draw_list,
}
}
/// Set number of segment used to draw the circle, default to 0.
/// Add more segments if you want a smoother circle.
pub fn num_segments(mut self, num_segments: u32) -> Self {
self.num_segments = num_segments;
self
}
/// Set circle's thickness (default to 1.0 pixel)
pub fn thickness(mut self, thickness: f32) -> Self {
self.thickness = thickness;
self
}
/// Set to `true` to make a filled circle (default to `false`).
pub fn filled(mut self, filled: bool) -> Self {
self.filled = filled;
self
}
/// Draw the circle on the window.
pub fn build(self) {
if self.filled {
unsafe {
sys::ImDrawList_AddCircleFilled(
self.draw_list.draw_list,
self.center.into(),
self.radius,
self.color.into(),
self.num_segments as i32,
)
}
} else {
unsafe {
sys::ImDrawList_AddCircle(
self.draw_list.draw_list,
self.center.into(),
self.radius,
self.color.into(),
self.num_segments as i32,
self.thickness,
)
}
}
}
}
/// Represents a Bezier curve about to be drawn
#[must_use = "should call .build() to draw the object"]
pub struct BezierCurve<'ui> {
pos0: [f32; 2],
cp0: [f32; 2],
pos1: [f32; 2],
cp1: [f32; 2],
color: ImColor32,
thickness: f32,
/// If num_segments is not set, the bezier curve is auto-tessalated.
num_segments: Option<u32>,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> BezierCurve<'ui> {
/// Typically constructed by [`DrawListMut::add_bezier_curve`]
pub fn new<C>(
draw_list: &'ui DrawListMut<'_>,
pos0: [f32; 2],
cp0: [f32; 2],
cp1: [f32; 2],
pos1: [f32; 2],
c: C,
) -> Self
where
C: Into<ImColor32>,
{
Self {
pos0,
cp0,
cp1,
pos1,
color: c.into(),
thickness: 1.0,
num_segments: None,
draw_list,
}
}
/// Set curve's thickness (default to 1.0 pixel)
pub fn thickness(mut self, thickness: f32) -> Self {
self.thickness = thickness;
self
}
/// Set number of segments used to draw the Bezier curve. If not set, the
/// bezier curve is auto-tessalated.
pub fn num_segments(mut self, num_segments: u32) -> Self {
self.num_segments = Some(num_segments);
self
}
/// Draw the curve on the window.
pub fn build(self) {
unsafe {
sys::ImDrawList_AddBezierCubic(
self.draw_list.draw_list,
self.pos0.into(),
self.cp0.into(),
self.cp1.into(),
self.pos1.into(),
self.color.into(),
self.thickness,
self.num_segments.unwrap_or(0) as i32,
)
}
}
}
/// Image draw list primitive, not to be confused with the widget
/// [`imgui::Image`](crate::Image).
#[must_use = "should call .build() to draw the object"]
pub struct Image<'ui> {
texture_id: TextureId,
p_min: [f32; 2],
p_max: [f32; 2],
uv_min: [f32; 2],
uv_max: [f32; 2],
col: ImColor32,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> Image<'ui> {
/// Typically constructed by [`DrawListMut::add_image`]
pub fn new(
draw_list: &'ui DrawListMut<'_>,
texture_id: TextureId,
p_min: [f32; 2],
p_max: [f32; 2],
) -> Self {
Self {
texture_id,
p_min,
p_max,
uv_min: [0.0, 0.0],
uv_max: [1.0, 1.0],
col: [1.0, 1.0, 1.0, 1.0].into(),
draw_list,
}
}
/// Set uv_min (default `[0.0, 0.0]`)
pub fn uv_min(mut self, uv_min: [f32; 2]) -> Self {
self.uv_min = uv_min;
self
}
/// Set uv_max (default `[1.0, 1.0]`)
pub fn uv_max(mut self, uv_max: [f32; 2]) -> Self {
self.uv_max = uv_max;
self
}
/// Set color tint (default: no tint/white `[1.0, 1.0, 1.0, 1.0]`)
pub fn col<C>(mut self, col: C) -> Self
where
C: Into<ImColor32>,
{
self.col = col.into();
self
}
/// Draw the image on the window.
pub fn build(self) {
use std::os::raw::c_void;
unsafe {
sys::ImDrawList_AddImage(
self.draw_list.draw_list,
self.texture_id.id() as *mut c_void,
self.p_min.into(),
self.p_max.into(),
self.uv_min.into(),
self.uv_max.into(),
self.col.into(),
);
}
}
}
/// Represents a image about to be drawn
#[must_use = "should call .build() to draw the object"]
pub struct ImageQuad<'ui> {
texture_id: TextureId,
p1: [f32; 2],
p2: [f32; 2],
p3: [f32; 2],
p4: [f32; 2],
uv1: [f32; 2],
uv2: [f32; 2],
uv3: [f32; 2],
uv4: [f32; 2],
col: ImColor32,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> ImageQuad<'ui> {
/// Typically constructed by [`DrawListMut::add_image_quad`]
pub fn new(
draw_list: &'ui DrawListMut<'_>,
texture_id: TextureId,
p1: [f32; 2],
p2: [f32; 2],
p3: [f32; 2],
p4: [f32; 2],
) -> Self {
Self {
texture_id,
p1,
p2,
p3,
p4,
uv1: [0.0, 0.0],
uv2: [1.0, 0.0],
uv3: [1.0, 1.0],
uv4: [0.0, 1.0],
col: [1.0, 1.0, 1.0, 1.0].into(),
draw_list,
}
}
/// Set uv coordinates of each point of the quad. If not called, defaults are:
///
/// ```text
/// uv1: [0.0, 0.0],
/// uv2: [1, 0],
/// uv3: [1, 1],
/// uv4: [0, 1],
/// ```
pub fn uv(mut self, uv1: [f32; 2], uv2: [f32; 2], uv3: [f32; 2], uv4: [f32; 2]) -> Self {
self.uv1 = uv1;
self.uv2 = uv2;
self.uv3 = uv3;
self.uv4 = uv4;
self
}
/// Set color tint (default: no tint/white `[1.0, 1.0, 1.0, 1.0]`)
pub fn col<C>(mut self, col: C) -> Self
where
C: Into<ImColor32>,
{
self.col = col.into();
self
}
/// Draw the image on the window.
pub fn build(self) {
use std::os::raw::c_void;
unsafe {
sys::ImDrawList_AddImageQuad(
self.draw_list.draw_list,
self.texture_id.id() as *mut c_void,
self.p1.into(),
self.p2.into(),
self.p3.into(),
self.p4.into(),
self.uv1.into(),
self.uv2.into(),
self.uv3.into(),
self.uv4.into(),
self.col.into(),
);
}
}
}
/// Represents a image about to be drawn. Similar to [`Image`] but
/// with corners rounded with a given radius
#[must_use = "should call .build() to draw the object"]
pub struct ImageRounded<'ui> {
texture_id: TextureId,
p_min: [f32; 2],
p_max: [f32; 2],
uv_min: [f32; 2],
uv_max: [f32; 2],
col: ImColor32,
rounding: f32,
draw_flags: ImDrawCornerFlags,
draw_list: &'ui DrawListMut<'ui>,
}
impl<'ui> ImageRounded<'ui> {
/// Typically constructed by [`DrawListMut::add_image_rounded`]
pub fn new(
draw_list: &'ui DrawListMut<'_>,
texture_id: TextureId,
p_min: [f32; 2],
p_max: [f32; 2],
rounding: f32,
) -> Self {
Self {
texture_id,
p_min,
p_max,
uv_min: [0.0, 0.0],
uv_max: [1.0, 1.0],
col: [1.0, 1.0, 1.0, 1.0].into(),
rounding,
draw_flags: ImDrawCornerFlags::ALL,
draw_list,
}
}
/// Set uv_min (default `[0.0, 0.0]`)
pub fn uv_min(mut self, uv_min: [f32; 2]) -> Self {
self.uv_min = uv_min;
self
}
/// Set uv_max (default `[1.0, 1.0]`)
pub fn uv_max(mut self, uv_max: [f32; 2]) -> Self {
self.uv_max = uv_max;
self
}
/// Set color tint (default: no tint/white `[1.0, 1.0, 1.0, 1.0]`)
pub fn col<C>(mut self, col: C) -> Self
where
C: Into<ImColor32>,
{
self.col = col.into();
self
}
/// Set flag to indicate rounding on all all corners.
pub fn round_all(mut self, value: bool) -> Self {
self.draw_flags.set(ImDrawCornerFlags::ALL, value);
self
}
/// Set flag to indicate if image's top-left corner will be rounded.
pub fn round_top_left(mut self, value: bool) -> Self {
self.draw_flags
.set(ImDrawCornerFlags::TOP_LEFT, value);
self
}
/// Set flag to indicate if image's top-right corner will be rounded.
pub fn round_top_right(mut self, value: bool) -> Self {
self.draw_flags
.set(ImDrawCornerFlags::TOP_RIGHT, value);
self
}
/// Set flag to indicate if image's bottom-left corner will be rounded.
pub fn round_bot_left(mut self, value: bool) -> Self {
self.draw_flags
.set(ImDrawCornerFlags::BOT_LEFT, value);
self
}
/// Set flag to indicate if image's bottom-right corner will be rounded.
pub fn round_bot_right(mut self, value: bool) -> Self {
self.draw_flags
.set(ImDrawCornerFlags::BOT_RIGHT, value);
self
}
/// Draw the image on the window.
pub fn build(self) {
use std::os::raw::c_void;
unsafe {
sys::ImDrawList_AddImageRounded(
self.draw_list.draw_list,
self.texture_id.id() as *mut c_void,
self.p_min.into(),
self.p_max.into(),
self.uv_min.into(),
self.uv_max.into(),
self.col.into(),
self.rounding,
self.draw_flags.bits() as i32,
);
}
}
}