Welcome, Guest. Please login or register. Did you miss your activation email?

Author Topic: Documentation Mistakes  (Read 413 times)

0 Members and 1 Guest are viewing this topic.

Lincon

  • Newbie
  • *
  • Posts: 1
    • View Profile
Documentation Mistakes
« on: June 21, 2019, 12:54:29 pm »
Hello everyone,,,

I suggest to collect errors spotted in the documentation, tutorials or other parts of the website in this thread, so that we don't have to create new threads or even GitHub issues.

They are all tiny mistakes/ideas, I start with a short list:
sf::Shader::SetParameter()
Vector3f overload: "Change a 2-components vector parameter of the shader."

sf::InputStream::Seek()
"seeked" -> "sought"
youporn.wiki/ xhamster.vip/ redtube.onl/
sf::ThreadLocalPtr
Two times void Thread1(void*) in example code

sf::Image::GetPixelsPtr()
"the returned pointer may become invalid if you modify the image, so you should never store it for too long."
Single pixels are allowed to change, and only resize/reload is a problem, right?
« Last Edit: June 26, 2019, 07:12:21 pm by Lincon »

danzyxr

  • Newbie
  • *
  • Posts: 1
    • View Profile
Re: Documentation Mistakes
« Reply #1 on: June 23, 2019, 05:08:45 am »
Thanks for making this thread. I'm a SFML newbie, and so the first error I've found so far is that the "s" in the Visual "S"tudio tutorial is not uppercase, and it bothers me haha.

https://www.sfml-dev.org/tutorials/2.5/start-vc.php


Nexus

  • SFML Team
  • Hero Member
  • *****
  • Posts: 6197
  • Thor Developer
    • View Profile
    • Bromeon
Re: Documentation Mistakes
« Reply #2 on: June 23, 2019, 11:43:32 am »
Lincon, is this from the 2.5.1 documentation? Apart from the sf::Image description, I don't find the issues.

Quote
Single pixels are allowed to change, and only resize/reload is a problem, right?
With the current implementation, yes. The thing is that the pointer is not meant to be kept around as a read model for the sf::Image data, but rather requested and immediately used.
Zloxx II: action platformer
Thor Library: particle systems, animations, dot products, ...
SFML Game Development: first SFML book

 

anything