SFML community forums

General => SFML website => Topic started by: AlexAUT on August 26, 2014, 09:30:23 pm

Title: Link to the documentation at some points in the tutorials
Post by: AlexAUT on August 26, 2014, 09:30:23 pm

Yesterday I was looking for the supported file formats by SFML and found this sentece in the "Sprites and textures" tutorial

Quote

SFML supports the most common file formats. The full list is available in the API documentation.

I think it would be nice if there is a link to the documentation to see the full list.


Edit1: same for audio would be nice



AlexAUT

Title: Re: Link to the documentation at some points in the tutorials
Post by: Hapax on August 27, 2014, 12:06:47 am

Image, Texture

Quote

The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic.
Some format options are not supported, like progressive jpeg.

https://github.com/SFML/SFML/blob/master/include/SFML/Graphics/Image.hpp

Music, SoundBuffer

Quote

Here is a complete list of all the supported audio formats:
ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.

https://github.com/SFML/SFML/blob/master/include/SFML/Audio/Music.hpp
https://github.com/SFML/SFML/blob/master/include/SFML/Audio/SoundBuffer.hpp

(as of 26 August 2014)

Title: Re: Link to the documentation at some points in the tutorials
Post by: Ixrec on August 27, 2014, 12:42:06 am

I think he was suggesting those links be put into the tutorials themselves.

But since the full list of audio formats has been posted, it's worth mentioning that libsndfile will be dropped at some point (https://github.com/SFML/SFML/issues/604) so that list will probably change.

Title: Re: Link to the documentation at some points in the tutorials
Post by: AlexAUT on August 27, 2014, 12:46:21 am

Quote from: Ixrec on August 27, 2014, 12:42:06 am

I think he was suggesting those links be put into the tutorials themselves.

Yeah, sry if it was a bit unclear.


AlexAUT

Title: Re: Link to the documentation at some points in the tutorials
Post by: Hapax on August 27, 2014, 01:09:57 am

Quote from: Ixrec on August 27, 2014, 12:42:06 am

I think he was suggesting those links be put into the tutorials themselves.

Yeah, I did think that (it probably should be there) but I thought it should be here until then in case someone in the future searches the forum for this information.

Title: Re: Link to the documentation at some points in the tutorials
Post by: eXpl0it3r on September 23, 2014, 07:22:35 pm

I guess it doesn't hurt to add the links for the relevant stuff. :)