Samarium Docs

Samarium is a 2d physics and rendering engine, written in modern C++20

Contents

• Real Time Simulation - Poster
  • Problem
  • Why is Real Time needed?
  • Why GPUs are a Solution
  • Hashgrids

Links

• Symbol Index
• Github

Usage

• Installation
• Examples
  • Softbody
  • Hilbert Curve
  • Fourier Shape
  • Maxwell-Boltzmann Distribution
  • Flow Field Noise
  • Mandelbrot
  • Poisson Disc Sampling
  • Prime Spiral
  • Second Order Dynamics
  • Softbody
• Basics
• Coordinate Systems

Physics

• Two Particle Collision
  • Setup
  • Detection
  • Handling

API Reference

• Math
  • Core Math Functions
    • math
      • math::almost_equal()
      • math::min()
      • math::max()
      • math::power()
      • math::to_degrees()
      • math::to_radians()
      • math::abs()
      • math::sign()
      • math::sign()
      • math::sign()
      • math::mod()
      • math::wrap_max()
      • math::wrap_min_max()
      • math::round_to_nearest()
      • math::ceil_to_nearest()
      • math::floor_to_nearest()
      • math::sample()
      • math::integral()
      • math::sum()
      • math::mean()
      • math::distance()
      • math::distance_sq()
      • math::within_distance()
      • math::lerp_along()
      • math::clamped_lerp_along()
      • math::project()
      • math::project_clamped()
      • math::distance()
      • math::clamped_distance()
      • math::lies_in_segment()
      • math::intersection()
      • math::clamped_intersection()
      • math::intersection()
      • math::area()
      • math::area()
      • math::abs_area()
      • math::abs_area()
      • math::regular_polygon_points()
      • math::regular_polygon_points()
      • math::regular_polygon_points()
      • math::regular_polygon_points()
      • math::two_pi_i
      • math::epsilon
      • math::pi
      • math::two_thirds_pi
      • math::two_pi
      • math::e
      • math::sqrt2
  • Vec2
    • sm
      • sm::Vec2
      • sm::Vec2f
      • sm::Indices
      • sm::Dimensions
      • sm::operator+()
      • sm::operator-()
      • sm::operator*()
      • sm::operator*()
      • sm::operator*()
      • sm::operator/()
      • sm::operator/()
      • sm::operator/()
      • sm::Vec2_t
        • sm::Vec2_t::value_type
        • sm::Vec2_t::length()
        • sm::Vec2_t::length_sq()
        • sm::Vec2_t::angle()
        • sm::Vec2_t::slope()
        • sm::Vec2_t::x
        • sm::Vec2_t::y
        • sm::Vec2_t::combine()
        • sm::Vec2_t::make()
        • sm::Vec2_t::Polar
          • sm::Vec2_t::Polar::length
          • sm::Vec2_t::Polar::angle
      • sm::literals
        • sm::literals::operator""_x()
        • sm::literals::operator""_y()
  • Interp
    • interp
      • interp::smooth_step()
      • interp::smoother_step()
      • interp::ease()
      • interp::ease2()
      • interp::ease_in_sine()
      • interp::ease_out_sine()
      • interp::ease_sine()
      • interp::ease_in_quad()
      • interp::ease_out_quad()
      • interp::ease_quad()
      • interp::ease_in_cubic()
      • interp::ease_out_cubic()
      • interp::ease_cubic()
      • interp::ease_in_quart()
      • interp::ease_out_quart()
      • interp::ease_quart()
      • interp::ease_in_quint()
      • interp::ease_out_quint()
      • interp::ease_quint()
      • interp::ease_in_expo()
      • interp::ease_out_expo()
      • interp::ease_expo()
      • interp::ease_in_circ()
      • interp::ease_out_circ()
      • interp::ease_circ()
      • interp::ease_in_back()
      • interp::ease_out_back()
      • interp::ease_back()
      • interp::ease_in_elastic()
      • interp::ease_out_elastic()
      • interp::ease_elastic()
      • interp::in_range()
      • interp::clamp()
      • interp::lerp()
      • interp::clamped_lerp()
      • interp::lerp_rgb()
      • interp::lerp_rotate()
      • interp::clamped_lerp_rotate()
      • interp::lerp_inverse()
      • interp::map_range()
      • interp::map_range_clamp()
      • interp::make_mapper()
      • interp::make_clamped_mapper()
      • interp::lerp_points()
  • Bounding Box
    • sm
      • sm::PlacementX
        • sm::PlacementX::Left
        • sm::PlacementX::Middle
        • sm::PlacementX::Right
      • sm::PlacementY
        • sm::PlacementY::Bottom
        • sm::PlacementY::Middle
        • sm::PlacementY::Top
      • sm::Placement
        • sm::Placement::x
        • sm::Placement::y
      • sm::Box2
        • sm::Box2::VecType
        • sm::Box2::cast()
        • sm::Box2::validate()
        • sm::Box2::validated()
        • sm::Box2::contains()
        • sm::Box2::diagonal()
        • sm::Box2::clamp()
        • sm::Box2::clamped_to()
        • sm::Box2::width()
        • sm::Box2::height()
        • sm::Box2::x_range()
        • sm::Box2::y_range()
        • sm::Box2::operator==()
        • sm::Box2::centre()
        • sm::Box2::set_centre()
        • sm::Box2::set_width()
        • sm::Box2::set_height()
        • sm::Box2::scaled()
        • sm::Box2::scaled_x()
        • sm::Box2::scaled_y()
        • sm::Box2::line_segments()
        • sm::Box2::get_placement()
        • sm::Box2::min
        • sm::Box2::max
        • sm::Box2::fit_points()
        • sm::Box2::fit_boxes()
        • sm::Box2::fit_boxes()
        • sm::Box2::square()
        • sm::Box2::from_centre_width_height()
  • Sample
    • sm
      • sm::math
        • sm::math::sample()
        • sm::math::integral()
  • SecondOrderDynamics
    • sm
      • sm::SecondOrderDynamics
        • sm::SecondOrderDynamics::SecondOrderDynamics()
        • sm::SecondOrderDynamics::update_parameters()
        • sm::SecondOrderDynamics::update()
        • sm::SecondOrderDynamics::update()
        • sm::SecondOrderDynamics::value
        • sm::SecondOrderDynamics::previous_input
        • sm::SecondOrderDynamics::vel
        • sm::SecondOrderDynamics::k1
        • sm::SecondOrderDynamics::k2
        • sm::SecondOrderDynamics::k3
• gl
  • gl
    • sm
      • sm::gl
        • sm::gl::BufferType
          • sm::gl::BufferType::Vertex
          • sm::gl::BufferType::Element
          • sm::gl::BufferType::Uniform
          • sm::gl::BufferType::ShaderStorage
        • sm::gl::Usage
          • sm::gl::Usage::StaticDraw
          • sm::gl::Usage::StaticRead
          • sm::gl::Usage::StaticCopy
          • sm::gl::Usage::StreamDraw
          • sm::gl::Usage::StreamRead
          • sm::gl::Usage::StreamCopy
          • sm::gl::Usage::DynamicDraw
          • sm::gl::Usage::DynamicRead
          • sm::gl::Usage::DynamicCopy
        • sm::gl::Access
          • sm::gl::Access::Read
          • sm::gl::Access::Write
          • sm::gl::Access::ReadWrite
        • sm::gl::Primitive
          • sm::gl::Primitive::Points
          • sm::gl::Primitive::Lines
          • sm::gl::Primitive::LineLoop
          • sm::gl::Primitive::LineStrip
          • sm::gl::Primitive::Triangles
          • sm::gl::Primitive::TriangleStrip
          • sm::gl::Primitive::TriangleFan
        • sm::gl::ImageFormat
          • sm::gl::ImageFormat::RGBA8
          • sm::gl::ImageFormat::RGB8
          • sm::gl::ImageFormat::R8
          • sm::gl::ImageFormat::R32F
          • sm::gl::ImageFormat::RG32F
          • sm::gl::ImageFormat::RGB32F
          • sm::gl::ImageFormat::RGBA32F
        • sm::gl::get_current()
        • sm::gl::message_callback()
        • sm::gl::enable_debug_output()
        • sm::gl::version_major
        • sm::gl::version_minor
        • sm::gl::unit_square
        • sm::gl::FormatAndType
          • sm::gl::FormatAndType::FormatAndType()
          • sm::gl::FormatAndType::format
          • sm::gl::FormatAndType::type
  • Draw
• Physics
  • Particle
    • sm
      • sm::Particle
        • sm::Particle::as_circle()
        • sm::Particle::apply_force()
        • sm::Particle::update()
        • sm::Particle::operator==()
        • sm::Particle::pos
        • sm::Particle::vel
        • sm::Particle::acc
        • sm::Particle::radius
        • sm::Particle::mass
  • ParticleSystem
• util
  • run
    • sm
      • sm::run()
      • sm::run()
      • sm::run()
      • sm::zoom_pan()
      • sm::zoom_pan()
  • file
    • file
      • file::Path
      • file::read_str()
      • file::read_str_unsafe()
      • file::read_image()
      • file::write()
      • file::write()
      • file::write()
      • file::write()
      • file::find()
      • file::find()
      • file::find()
      • file::targa
      • file::pam
      • file::png
      • file::bmp
      • file::Targa
      • file::Pam
      • file::Png
      • file::Bmp
• Include Graph

About

• Changelog
  • 1.0.1
    • Additions
• License