Update the documentation to reflect web support (#1183)

* Update the documentation to reflect web support

Indicate which methods have platform-specific web behavior

* cargo fmt
This commit is contained in:
Ryan G 2019-09-24 19:33:32 -04:00 committed by GitHub
parent 28a50817af
commit 8cea3e262b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 53 additions and 8 deletions

View file

@ -10,19 +10,21 @@ impl Handle {
}
pub fn position(&self) -> PhysicalPosition {
unimplemented!();
PhysicalPosition { x: 0.0, y: 0.0 }
}
pub fn name(&self) -> Option<String> {
unimplemented!();
None
}
pub fn size(&self) -> PhysicalSize {
unimplemented!();
PhysicalSize {
width: 0.0,
height: 0.0,
}
}
pub fn video_modes(&self) -> impl Iterator<Item = VideoMode> {
// TODO: is this possible ?
std::iter::empty()
}
}

View file

@ -177,13 +177,13 @@ impl Window {
#[inline]
pub fn set_cursor_position(&self, _position: LogicalPosition) -> Result<(), ExternalError> {
// TODO: pointer capture
// Intentionally a no-op, as the web does not support setting cursor positions
Ok(())
}
#[inline]
pub fn set_cursor_grab(&self, _grab: bool) -> Result<(), ExternalError> {
// TODO: pointer capture
// Intentionally a no-op, as the web does not (properly) support grabbing the cursor
Ok(())
}
@ -199,7 +199,7 @@ impl Window {
#[inline]
pub fn set_maximized(&self, _maximized: bool) {
// TODO: should there be a maximization / fullscreen API?
// Intentionally a no-op, as canvases cannot be 'maximized'
}
#[inline]
@ -230,7 +230,7 @@ impl Window {
#[inline]
pub fn set_ime_position(&self, _position: LogicalPosition) {
// TODO: what is this?
// Currently a no-op as it does not seem there is good support for this on web
}
#[inline]