Guide Examples API reference

English 简体中文日本語 한국어

Preparing search index…

API reference/WindowVariable

MouseButtonCount

Const

MouseButtonCount: 5

The total number of mouse buttons

Source & inheritance

Defined in src/window/gen/constants.ts:2199

Settings

Member Visibility

Protected
Inherited
External

Theme

Modules

System

Classes

Angle
Clock
FileInputStream
InputStream
MemoryInputStream
SFMLError
SuspendAwareClock
Time
TimeoutWithPredicate
Vector2
Vector2f
Vector2i
Vector2u
Vector3
Vector3f
Vector3i
Vector3u

Interfaces

Version

Namespaces

Unicode

Type Aliases

ReadonlyValue
ScalarType
StreamResult
TimeoutPredicate

Functions

degrees
err
microseconds
milliseconds
modulo
moduloAssign
radians
seconds
setErrorOutput
sleep
Unicode.isGraphemeBoundary
Unicode.isSentenceBoundary
Unicode.isWordBoundary
version

Variables

add
addAssign
divide
divideAssign
equal
greater
greaterEqual
less
lessEqual
multiply
multiplyAssign
negate
notEqual
subtract
subtractAssign

Window

Classes

Context
Cursor
Event
VideoMode
Window

Interfaces

ContextSettings
EventPayloads
Joystick.Identification
WindowOptions

Namespaces

Clipboard
Joystick
Keyboard
Mouse
Sensor
Touch
Vulkan

Enumerations

ContextAttribute
CursorType
JoystickAxis
KeyboardKey
KeyboardScancode
MouseButton
MouseWheel
SensorType
State
Style

Type Aliases

EventData
EventHandlers
EventKind
EventVisitor
ReadonlyContext
WindowHandle

Functions

Clipboard.getString
Clipboard.setString
Joystick.getAxisPosition
Joystick.getButtonCount
Joystick.getIdentification
Joystick.hasAxis
Joystick.isButtonPressed
Joystick.isConnected
Joystick.update
Keyboard.delocalize
Keyboard.getDescription
Keyboard.isKeyPressed
Keyboard.localize
Keyboard.setVirtualKeyboardVisible
Mouse.getPosition
Mouse.isButtonPressed
Mouse.setPosition
Sensor.getValue
Sensor.isAvailable
Sensor.setEnabled
Touch.getPosition
Touch.isDown
Vulkan.getFunction
Vulkan.getGraphicsRequiredInstanceExtensions
Vulkan.isAvailable

Variables

JoystickAxisCount
JoystickButtonCount
JoystickCount
KeyboardKeyCount
KeyboardScancodeCount
MouseButtonCount
SensorCount

Graphics

Classes

Interfaces

CircleShapeOptions
FontInfo
GlyphAppearance
ReadonlyRenderStates
ShapedGlyph
StencilModeOptions
TextOptions

Namespaces

Glsl

Enumerations

BlendEquation
BlendFactor
ClusterGrouping
CoordinateType
LineAlignment
PrimitiveType
ShaderType
StencilComparison
StencilUpdateOperation
TextDirection
TextOrientation
TextStyle
VertexBufferUsage

Type Aliases

GlyphPreProcessor
ReadonlyFont
ReadonlyPixels
ReadonlyShader
ReadonlyTexture
RenderStatesInput
RenderStatesOptions
RenderTextureSettings

Functions

swap

Variables

BlendAdd
BlendAlpha
BlendMax
BlendMin
BlendMultiply
BlendNone

Audio

Classes

Cone
EffectProcessor
InputSoundFile
Music
OutputSoundFile
Sound
SoundBuffer
SoundBufferRecorder
SoundFileFactory
SoundFileReader
SoundFileReaderInfo
SoundFileWriter
SoundRecorder
SoundSource
SoundStream
TimeSpan

Interfaces

AudioWorkerContext
AudioWorkerModule
AudioWorkerOptions
AudioWorkerStats
ConeInput
EffectFrames
EffectProcessorCallbacks
EffectProcessorOptions
SoundFileReaderConstructor
SoundFileReaderInfoInput
SoundFileWriterConstructor
SoundRecorderCallbacks
SoundStreamCallbacks
SoundStreamChunk
SoundStreamOptions
TimeSpanInput

Namespaces

Listener
PlaybackDevice

Enumerations

PlaybackDevice.Notification
SoundChannel
SoundStatus

Type Aliases

ChannelMap
PlaybackDevice.NotificationCallback
ReadonlySamples
ReadonlySoundBuffer

Functions

Listener.getCone
Listener.getDirection
Listener.getGlobalVolume
Listener.getPosition
Listener.getUpVector
Listener.getVelocity
Listener.setCone
Listener.setDirection
Listener.setGlobalVolume
Listener.setPosition
Listener.setUpVector
Listener.setVelocity
PlaybackDevice.getAvailableDevices
PlaybackDevice.getDefaultDevice
PlaybackDevice.getDevice
PlaybackDevice.getDeviceSampleRate
PlaybackDevice.isDefaultDevice
PlaybackDevice.setDevice
PlaybackDevice.setDeviceToDefault
PlaybackDevice.setDeviceToNull
PlaybackDevice.setNotificationCallback

Network

Classes

Ftp
FtpDirectoryResponse
FtpListingResponse
FtpResponse
Http
HttpRequest
HttpResponse
IpAddress
Packet
Sftp
SftpAttributesResult
SftpListingResult
SftpPathResult
SftpResult
Socket
SocketSelector
TcpListener
TcpSocket
UdpSocket

Interfaces

DatagramResult
Dns.MxRecord
Dns.SrvRecord
PacketValues
SftpAttributes
SftpSessionInfo
SftpUploadChunk
SocketSendResult
SocketTransfer

Namespaces

Dns

Enumerations

FileType
FtpStatus
HttpMethod
HttpStatus
IpAddressType
ReadinessType
SftpHostKeyType
SftpResultValue
SocketStatus
SocketType
TlsStatus
TransferMode

Type Aliases

PacketType
ReadyCallback
SftpDownloadCallback
SftpTimeout
SftpUploadCallback
SocketHandle

Functions

Dns.getPublicAddress
Dns.queryMx
Dns.queryNs
Dns.querySrv
Dns.queryTxt
Dns.resolve

Generated using TypeDoc

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0