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

About

• Changelog
  • 1.0.1
    • Additions
• License