reference-libobs-graphics-axisang.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. Axis Angle
  2. ==========
  3. Provides a helper structure for conversion to quaternions.
  4. .. code:: cpp
  5. #include <graphics/axisang.h>
  6. .. type:: struct axisang
  7. .. member:: float axisang.x
  8. X axis
  9. .. member:: float axisang.y
  10. Y axis
  11. .. member:: float axisang.z
  12. Z axis
  13. .. member:: float axisang.w
  14. Angle
  15. .. member:: float axisang.ptr[4]
  16. ---------------------
  17. .. function:: void axisang_zero(struct axisang *dst)
  18. Zeroes the axis angle.
  19. :param dst: Axis angle
  20. ---------------------
  21. .. function:: void axisang_copy(struct axisang *dst, struct axisang *aa)
  22. Copies an axis angle.
  23. :param dst: Axis angle to copy to
  24. :param aa: Axis angle to copy from
  25. ---------------------
  26. .. function:: void axisang_set(struct axisang *dst, float x, float y, float z, float w)
  27. Sets an axis angle.
  28. :param dst: Axis angle to set
  29. :param x: X axis
  30. :param y: Y axis
  31. :param z: Z axis
  32. :param w: Angle
  33. ---------------------
  34. .. function:: void axisang_from_quat(struct axisang *dst, const struct quat *q)
  35. Creates an axis angle from a quaternion.
  36. :param dst: Axis angle destination
  37. :param q: Quaternion to convert